cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sebgoa <run...@gmail.com>
Subject Re: Cloudstack documentation
Date Tue, 18 Mar 2014 15:25:51 GMT

On Mar 18, 2014, at 3:50 PM, Pierre-Luc Dion <pdion@cloudops.com> wrote:

> Thanks Sebastien,
> 
> 
> Seams quite complete! Is there a reason why doc url on
> http://cloudstack.apache.org/ still point to the old doc ?

My plan is to make the switch once 4.3 is out.

There is still some cleaning up to do on the .rst/RTD stuff which would be nice to fix before
making it official.

Also, we might have to vote on docs releases…haven't touched that one yet :)

-sebastien

> 
> 
> 
> Pierre-Luc Dion
> Architecte de Solution Cloud | Cloud Solutions Architect
> 514-447-3456, 1101
> - - -
> 
> *CloudOps*420 rue Guy
> Montréal QC  H3J 1S6
> www.cloudops.com
> @CloudOps_
> 
> 
> On Tue, Mar 18, 2014 at 10:16 AM, sebgoa <runseb@gmail.com> wrote:
> 
>> 
>> On Mar 18, 2014, at 3:02 PM, Pierre-Luc Dion <pdion@cloudops.com> wrote:
>> 
>>> Thanks Wido,
>>> 
>>> Cool, look like the rtd version is in there too.  so I guest we need a
>> lot
>>> of work on conversion from publican to RST?
>> 
>> It' already done :) I'd be mean I would tell you to search the mailing
>> list :)
>> 
>> If you search the cloudstack mirrors on github:
>> https://github.com/orgs/apache?query=cloudstack
>> 
>> you will see four documentation repo.
>> cloudstack-docs
>> cloudstack-docs-rn (release notes)
>> cloudstack-docs-admin (the admin guide)
>> cloudstack-docs-install (the installation guide)
>> 
>> the rn, admin and installation guide are pure rest, and are a conversion
>> of the publican to .rst. there is still work to do, especially on the admin
>> guide.
>> 
>> These docs are pushed automatically to readthedocs.org and provide:
>> 
>> http://apache-cloudstack-release-notes.readthedocs.org/en/latest/
>> http://cloudstack-installation.readthedocs.org/en/latest/
>> http://cloudstack-administration.readthedocs.org/en/latest/
>> http://docs.cloudstack.apache.org
>> 
>> I am actively working on cleaning this up and fixing the URLs/CNAMEs.
>> 
>> The easiest way to contribute is *really* to visit the RTD sites and click
>> on the "edit on github" button, this will automatically fork the repo in
>> your github account.
>> You can then submit a pull request. It will send a notification on dev@list and we
can merge it.
>> 
>> There is still lots of work to do, both on the formatting (the conversion
>> was not perfect) and the content of course.
>> 
>> Have at it, I'd be delighted to merge your patches :)
>> 
>> -sebastien
>> 
>>> 
>>> 
>>> 
>>> 
>>> Pierre-Luc Dion
>>> Architecte de Solution Cloud | Cloud Solutions Architect
>>> 514-447-3456, 1101
>>> - - -
>>> 
>>> *CloudOps*420 rue Guy
>>> Montréal QC  H3J 1S6
>>> www.cloudops.com
>>> @CloudOps_
>>> 
>>> 
>>> On Tue, Mar 18, 2014 at 9:15 AM, Wido den Hollander <wido@widodh.nl>
>> wrote:
>>> 
>>>> On 03/18/2014 02:08 PM, Pierre-Luc Dion wrote:
>>>> 
>>>>> Hi all,
>>>>> 
>>>>> I would like to know where we can get newer version of documentation
>> for
>>>>> Cloudstack. Look like the documentation site is not updated since
>> 4.2.0. I
>>>>> know that the documentation system will change, is their any
>> information
>>>>> about it somewhere?
>>>>> 
>>>>> 
>>>> Yes, it moved to it's own repository: https://git-wip-us.apache.org/
>>>> repos/asf?p=cloudstack-docs.git
>>>> 
>>>> $ git clone https://git-wip-us.apache.org/repos/asf/cloudstack-docs.git
>>>> 
>>>> From there you can probably build the docs yourself. Be aware that we
>> are
>>>> moving to RST.
>>>> 
>>>> 
>>>> Also, I would like to contribute as well.
>>>>> 
>>>>> 
>>>> Patches are always welcome!
>>>> 
>>>> Thanks,
>>>>> 
>>>>> Pierre-Luc Dion
>>>>> Architecte de Solution Cloud | Cloud Solutions Architect
>>>>> - - -
>>>>> 
>>>>> *CloudOps*420 rue Guy
>>>>> 
>>>>> Montréal QC  H3J 1S6
>>>>> www.cloudops.com
>>>>> @CloudOps_
>>>>> 
>>>>> 
>>>> 
>> 
>> 


Mime
View raw message