On Sun, Oct 18, 2015 at 10:16 PM, Eric <epretori...@yahoo.com.invalid>
wrote:

> Hello, All:
>
>
Hi Eric!


>
> I'd like to contribute to the Cloudstack project documentation.
>

That's excellent!


>
> What's the process for that? Is there a SIG? Are there guidelines or a
> style guide?
>

We use ReStructuredText to write our documentation and and readthedocs to
display them.
Generally there are two ways to edit the documentation.

1) Edit it on GitHub. Go to any source file and press the 'Fork this
project and edit the file'. This method gives easy access, but it is harder
to preview the result, and you are stuck with the GitHub UI
2) Fork the project(s) and edit in your favorite editor. This requires that
you have or learn some basic git knowledge.

You can find the following repositories on GitHub:

Administration guide: https://github.com/apache/cloudstack-docs-admin
Installation guide: https://github.com/apache/cloudstack-docs-install
Getting started: https://github.com/apache/cloudstack-docs
Release notes: https://github.com/apache/cloudstack-docs-rn

As for guidelines and/or style guides I'm not sure we have any, I guess we
are open for suggestions :-)


-- 
Erik Weber

Reply via email to