You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by Mike Tutkowski <mi...@solidfire.com> on 2013/08/06 20:52:54 UTC

Documentation Question

Hi,

I am working on documenting the SolidFire (storage) plug-in I developed for
4.2.

I have plenty of documentation handy, but am not familiar with how I should
document this for CloudStack.

Would someone be able to point me to a template so I know how mine
documentation should look and where it should be placed?

Thanks!

-- 
*Mike Tutkowski*
*Senior CloudStack Developer, SolidFire Inc.*
e: mike.tutkowski@solidfire.com
o: 303.746.7302
Advancing the way the world uses the
cloud<http://solidfire.com/solution/overview/?video=play>
*™*

Re: Documentation Question

Posted by Mike Tutkowski <mi...@solidfire.com>.
Great - thanks for the info!


On Tue, Aug 6, 2013 at 1:05 PM, Musayev, Ilya <im...@webmd.net> wrote:

> Hi Mike,
>
> We use publican for documentation.
>
> There is a section on wiki for docs,
> https://cwiki.apache.org/confluence/display/CLOUDSTACK/Doc+Writers
>
> Perhaps it will be helpful.
>
> Regards
> ilya
>
> > -----Original Message-----
> > From: Mike Tutkowski [mailto:mike.tutkowski@solidfire.com]
> > Sent: Tuesday, August 06, 2013 2:53 PM
> > To: dev@cloudstack.apache.org
> > Subject: Documentation Question
> >
> > Hi,
> >
> > I am working on documenting the SolidFire (storage) plug-in I developed
> for
> > 4.2.
> >
> > I have plenty of documentation handy, but am not familiar with how I
> should
> > document this for CloudStack.
> >
> > Would someone be able to point me to a template so I know how mine
> > documentation should look and where it should be placed?
> >
> > Thanks!
> >
> > --
> > *Mike Tutkowski*
> > *Senior CloudStack Developer, SolidFire Inc.*
> > e: mike.tutkowski@solidfire.com
> > o: 303.746.7302
> > Advancing the way the world uses the
> > cloud<http://solidfire.com/solution/overview/?video=play>
> > *(tm)*
>
>


-- 
*Mike Tutkowski*
*Senior CloudStack Developer, SolidFire Inc.*
e: mike.tutkowski@solidfire.com
o: 303.746.7302
Advancing the way the world uses the
cloud<http://solidfire.com/solution/overview/?video=play>
*™*

RE: Documentation Question

Posted by "Musayev, Ilya" <im...@webmd.net>.
Hi Mike,

We use publican for documentation.

There is a section on wiki for docs, https://cwiki.apache.org/confluence/display/CLOUDSTACK/Doc+Writers

Perhaps it will be helpful.

Regards
ilya

> -----Original Message-----
> From: Mike Tutkowski [mailto:mike.tutkowski@solidfire.com]
> Sent: Tuesday, August 06, 2013 2:53 PM
> To: dev@cloudstack.apache.org
> Subject: Documentation Question
> 
> Hi,
> 
> I am working on documenting the SolidFire (storage) plug-in I developed for
> 4.2.
> 
> I have plenty of documentation handy, but am not familiar with how I should
> document this for CloudStack.
> 
> Would someone be able to point me to a template so I know how mine
> documentation should look and where it should be placed?
> 
> Thanks!
> 
> --
> *Mike Tutkowski*
> *Senior CloudStack Developer, SolidFire Inc.*
> e: mike.tutkowski@solidfire.com
> o: 303.746.7302
> Advancing the way the world uses the
> cloud<http://solidfire.com/solution/overview/?video=play>
> *(tm)*

Re: Documentation Question

Posted by Mike Tutkowski <mi...@solidfire.com>.
It looks like I'll need to provide an XML file using certain tags and then
link to it from another doc.

I'm working on the content now.

Thanks again


On Tue, Aug 6, 2013 at 2:22 PM, Mike Tutkowski <mike.tutkowski@solidfire.com
> wrote:

> Yeah - thanks! :)
>
>
> On Tue, Aug 6, 2013 at 2:17 PM, Jessica Tomechak <
> Jessica.Tomechak@citrix.com> wrote:
>
>> Mike,
>> Is this what you are looking for?
>>
>> https://cwiki.apache.org/confluence/display/CLOUDSTACK/Doc+Writers
>>
>> Jessica T.
>> ________________________________________
>> From: Mike Tutkowski [mike.tutkowski@solidfire.com]
>> Sent: Tuesday, August 06, 2013 11:52 AM
>> To: dev@cloudstack.apache.org
>> Subject: Documentation Question
>>
>> Hi,
>>
>> I am working on documenting the SolidFire (storage) plug-in I developed
>> for
>> 4.2.
>>
>> I have plenty of documentation handy, but am not familiar with how I
>> should
>> document this for CloudStack.
>>
>> Would someone be able to point me to a template so I know how mine
>> documentation should look and where it should be placed?
>>
>> Thanks!
>>
>> --
>> *Mike Tutkowski*
>> *Senior CloudStack Developer, SolidFire Inc.*
>> e: mike.tutkowski@solidfire.com
>> o: 303.746.7302
>> Advancing the way the world uses the
>> cloud<http://solidfire.com/solution/overview/?video=play>
>> *™*
>>
>
>
>
> --
> *Mike Tutkowski*
> *Senior CloudStack Developer, SolidFire Inc.*
> e: mike.tutkowski@solidfire.com
> o: 303.746.7302
> Advancing the way the world uses the cloud<http://solidfire.com/solution/overview/?video=play>
> *™*
>



-- 
*Mike Tutkowski*
*Senior CloudStack Developer, SolidFire Inc.*
e: mike.tutkowski@solidfire.com
o: 303.746.7302
Advancing the way the world uses the
cloud<http://solidfire.com/solution/overview/?video=play>
*™*

Re: Documentation Question

Posted by Mike Tutkowski <mi...@solidfire.com>.
Yeah - thanks! :)


On Tue, Aug 6, 2013 at 2:17 PM, Jessica Tomechak <
Jessica.Tomechak@citrix.com> wrote:

> Mike,
> Is this what you are looking for?
>
> https://cwiki.apache.org/confluence/display/CLOUDSTACK/Doc+Writers
>
> Jessica T.
> ________________________________________
> From: Mike Tutkowski [mike.tutkowski@solidfire.com]
> Sent: Tuesday, August 06, 2013 11:52 AM
> To: dev@cloudstack.apache.org
> Subject: Documentation Question
>
> Hi,
>
> I am working on documenting the SolidFire (storage) plug-in I developed for
> 4.2.
>
> I have plenty of documentation handy, but am not familiar with how I should
> document this for CloudStack.
>
> Would someone be able to point me to a template so I know how mine
> documentation should look and where it should be placed?
>
> Thanks!
>
> --
> *Mike Tutkowski*
> *Senior CloudStack Developer, SolidFire Inc.*
> e: mike.tutkowski@solidfire.com
> o: 303.746.7302
> Advancing the way the world uses the
> cloud<http://solidfire.com/solution/overview/?video=play>
> *™*
>



-- 
*Mike Tutkowski*
*Senior CloudStack Developer, SolidFire Inc.*
e: mike.tutkowski@solidfire.com
o: 303.746.7302
Advancing the way the world uses the
cloud<http://solidfire.com/solution/overview/?video=play>
*™*

RE: Documentation Question

Posted by Jessica Tomechak <Je...@citrix.com>.
Mike,
Is this what you are looking for?

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Doc+Writers

Jessica T.
________________________________________
From: Mike Tutkowski [mike.tutkowski@solidfire.com]
Sent: Tuesday, August 06, 2013 11:52 AM
To: dev@cloudstack.apache.org
Subject: Documentation Question

Hi,

I am working on documenting the SolidFire (storage) plug-in I developed for
4.2.

I have plenty of documentation handy, but am not familiar with how I should
document this for CloudStack.

Would someone be able to point me to a template so I know how mine
documentation should look and where it should be placed?

Thanks!

--
*Mike Tutkowski*
*Senior CloudStack Developer, SolidFire Inc.*
e: mike.tutkowski@solidfire.com
o: 303.746.7302
Advancing the way the world uses the
cloud<http://solidfire.com/solution/overview/?video=play>
*™*