cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Tim Mackey <tmac...@gmail.com>
Subject Re: Getting Started With Documentation
Date Thu, 22 Oct 2015 19:38:32 GMT
On Tue, Oct 20, 2015 at 7:08 PM, Eric <epretorious@yahoo.com.invalid> wrote:

> Thanks, Erik!
> Is there a discussion forum where contributors can discuss documentation?
> I believe that, like all things in technology, there should be a set of
> conventions that guide authors in the use of common terms. e.g., Xen? Or
> Xen Project? Or XenServer?
>

One thing we want to ensure is that the terms we use are accurate.  In
CloudStack, as with the general tech world, there is a tendency to make Xen
== XenServer when it isn't.  XenServer is supported supported by CloudStack
via XAPI where the Xen Project Hypervisor isn't currently present in native
form. Oracle VM is also supported by CloudStack, so we'd also want to
ensure any Xen discussion recognizes that Xen doesn't imply XenServer and
vice-versa.

In terms of other conventions, we've evolved to where we are and welcome
input for how the documentation can be both clearer and more usable.

-tim


>
> Eric PretoriousPortland, OR
>
>       From: Erik Weber <terbolous@gmail.com>
>  To: dev <dev@cloudstack.apache.org>; Eric <epretorious@yahoo.com>
>  Sent: Sunday, October 18, 2015 11:50 PM
>  Subject: Re: Getting Started With Documentation
>
> On Sun, Oct 18, 2015 at 10:16 PM, Eric <epretorious@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
>
>
>
>
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message