You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by Paul Angus <pa...@shapeblue.com> on 2018/07/24 09:25:26 UTC
[PROPOSE] Combining Apache CloudStack Documentation
Hi All,
We currently have four sources of documentation [1]. Which make managing the documentation convoluted, and worse, make navigating and searching the documentation really difficult.
I have taken the current documentation and combined them into one repo, then created 7 sections:
CloudStack Concepts and Terminology
Quick Installation Guide
Installation Guide
Usage Guide
Developers Guide
Plugins Guide
Release Notes
I haven't changed any of the content, but I've moved some of it around to make more sense (to me). You can see the result on RTD [2]
I'd like to PROPOSE to move this demo version of the documentation over to the Apache repos and make it THE documentation source, update the website, and mark the current repos/sites as archive data.
[1]
https://github.com/apache/cloudstack-docs.git <https://github.com/apache/cloudstack-docs.git> is a bit of a dodge-podge of resources
https://github.com/apache/cloudstack-docs-install.git is the install guide
https://github.com/apache/cloudstack-docs-admin.git is the current admin manual.
https://github.com/apache/cloudstack-docs-rn.git is the release notes for individual releases
[2] https://beta-cloudstack-docs.readthedocs.io/en/latest/
paul.angus@shapeblue.com
www.shapeblue.com
53 Chandos Place, Covent Garden, London WC2N 4HSUK
@shapeblue
RE: [PROPOSE] Combining Apache CloudStack Documentation
Posted by Paul Angus <pa...@shapeblue.com>.
We can certainly split them out from release notes quite easily
Kind regards,
Paul Angus
paul.angus@shapeblue.com
www.shapeblue.com
53 Chandos Place, Covent Garden, London WC2N 4HSUK
@shapeblue
-----Original Message-----
From: ilya musayev <il...@gmail.com>
Sent: 24 July 2018 11:02
To: dev@cloudstack.apache.org
Cc: users@cloudstack.apache.org
Subject: Re: [PROPOSE] Combining Apache CloudStack Documentation
I like it but wonder if Upgrade section needs to be added? ..
On Tue, Jul 24, 2018 at 2:25 AM Paul Angus <pa...@shapeblue.com> wrote:
> Hi All,
>
> We currently have four sources of documentation [1]. Which make
> managing the documentation convoluted, and worse, make navigating and
> searching the documentation really difficult.
>
> I have taken the current documentation and combined them into one
> repo, then created 7 sections:
>
> CloudStack Concepts and Terminology
> Quick Installation Guide
> Installation Guide
> Usage Guide
> Developers Guide
> Plugins Guide
> Release Notes
>
> I haven't changed any of the content, but I've moved some of it around
> to make more sense (to me). You can see the result on RTD [2]
>
> I'd like to PROPOSE to move this demo version of the documentation
> over to the Apache repos and make it THE documentation source, update
> the website, and mark the current repos/sites as archive data.
>
> [1]
> https://github.com/apache/cloudstack-docs.git <
> https://github.com/apache/cloudstack-docs.git> is a bit of a
> dodge-podge of resources
> https://github.com/apache/cloudstack-docs-install.git is the install
> guide https://github.com/apache/cloudstack-docs-admin.git is the
> current admin manual.
> https://github.com/apache/cloudstack-docs-rn.git is the release notes
> for individual releases
>
> [2] https://beta-cloudstack-docs.readthedocs.io/en/latest/
>
> paul.angus@shapeblue.com
> www.shapeblue.com
> 53 Chandos Place, Covent Garden, London WC2N 4HSUK @shapeblue
>
>
>
>
Re: [PROPOSE] Combining Apache CloudStack Documentation
Posted by Antoine Le Morvan <an...@le-morvan.net>.
Hello,
it would be interesting if the translations as french one were functional.
Otherwise I really like your project.
Antoine.
Le 24/07/2018 à 19:40, Tutkowski, Mike a écrit :
> I like this, too, Paul.
>
> On 7/24/18, 4:01 AM, "ilya musayev" <il...@gmail.com> wrote:
>
> I like it but wonder if Upgrade section needs to be added? ..
>
> On Tue, Jul 24, 2018 at 2:25 AM Paul Angus <pa...@shapeblue.com> wrote:
>
> > Hi All,
> >
> > We currently have four sources of documentation [1]. Which make managing
> > the documentation convoluted, and worse, make navigating and searching the
> > documentation really difficult.
> >
> > I have taken the current documentation and combined them into one repo,
> > then created 7 sections:
> >
> > CloudStack Concepts and Terminology
> > Quick Installation Guide
> > Installation Guide
> > Usage Guide
> > Developers Guide
> > Plugins Guide
> > Release Notes
> >
> > I haven't changed any of the content, but I've moved some of it around to
> > make more sense (to me). You can see the result on RTD [2]
> >
> > I'd like to PROPOSE to move this demo version of the documentation over to
> > the Apache repos and make it THE documentation source, update the website,
> > and mark the current repos/sites as archive data.
> >
> > [1]
> > https://github.com/apache/cloudstack-docs.git <
> > https://github.com/apache/cloudstack-docs.git> is a bit of a dodge-podge
> > of resources
> > https://github.com/apache/cloudstack-docs-install.git is the install guide
> > https://github.com/apache/cloudstack-docs-admin.git is the current admin
> > manual.
> > https://github.com/apache/cloudstack-docs-rn.git is the release notes for
> > individual releases
> >
> > [2] https://beta-cloudstack-docs.readthedocs.io/en/latest/
> >
> > paul.angus@shapeblue.com
> > www.shapeblue.com
> > 53 Chandos Place, Covent Garden, London WC2N 4HSUK
> > @shapeblue
> >
> >
> >
> >
>
>
Re: [PROPOSE] Combining Apache CloudStack Documentation
Posted by "Tutkowski, Mike" <Mi...@netapp.com>.
I like this, too, Paul.
On 7/24/18, 4:01 AM, "ilya musayev" <il...@gmail.com> wrote:
I like it but wonder if Upgrade section needs to be added? ..
On Tue, Jul 24, 2018 at 2:25 AM Paul Angus <pa...@shapeblue.com> wrote:
> Hi All,
>
> We currently have four sources of documentation [1]. Which make managing
> the documentation convoluted, and worse, make navigating and searching the
> documentation really difficult.
>
> I have taken the current documentation and combined them into one repo,
> then created 7 sections:
>
> CloudStack Concepts and Terminology
> Quick Installation Guide
> Installation Guide
> Usage Guide
> Developers Guide
> Plugins Guide
> Release Notes
>
> I haven't changed any of the content, but I've moved some of it around to
> make more sense (to me). You can see the result on RTD [2]
>
> I'd like to PROPOSE to move this demo version of the documentation over to
> the Apache repos and make it THE documentation source, update the website,
> and mark the current repos/sites as archive data.
>
> [1]
> https://github.com/apache/cloudstack-docs.git <
> https://github.com/apache/cloudstack-docs.git> is a bit of a dodge-podge
> of resources
> https://github.com/apache/cloudstack-docs-install.git is the install guide
> https://github.com/apache/cloudstack-docs-admin.git is the current admin
> manual.
> https://github.com/apache/cloudstack-docs-rn.git is the release notes for
> individual releases
>
> [2] https://beta-cloudstack-docs.readthedocs.io/en/latest/
>
> paul.angus@shapeblue.com
> www.shapeblue.com
> 53 Chandos Place, Covent Garden, London WC2N 4HSUK
> @shapeblue
>
>
>
>
RE: [PROPOSE] Combining Apache CloudStack Documentation
Posted by Paul Angus <pa...@shapeblue.com>.
We can certainly split them out from release notes quite easily
Kind regards,
Paul Angus
paul.angus@shapeblue.com
www.shapeblue.com
53 Chandos Place, Covent Garden, London WC2N 4HSUK
@shapeblue
-----Original Message-----
From: ilya musayev <il...@gmail.com>
Sent: 24 July 2018 11:02
To: dev@cloudstack.apache.org
Cc: users@cloudstack.apache.org
Subject: Re: [PROPOSE] Combining Apache CloudStack Documentation
I like it but wonder if Upgrade section needs to be added? ..
On Tue, Jul 24, 2018 at 2:25 AM Paul Angus <pa...@shapeblue.com> wrote:
> Hi All,
>
> We currently have four sources of documentation [1]. Which make
> managing the documentation convoluted, and worse, make navigating and
> searching the documentation really difficult.
>
> I have taken the current documentation and combined them into one
> repo, then created 7 sections:
>
> CloudStack Concepts and Terminology
> Quick Installation Guide
> Installation Guide
> Usage Guide
> Developers Guide
> Plugins Guide
> Release Notes
>
> I haven't changed any of the content, but I've moved some of it around
> to make more sense (to me). You can see the result on RTD [2]
>
> I'd like to PROPOSE to move this demo version of the documentation
> over to the Apache repos and make it THE documentation source, update
> the website, and mark the current repos/sites as archive data.
>
> [1]
> https://github.com/apache/cloudstack-docs.git <
> https://github.com/apache/cloudstack-docs.git> is a bit of a
> dodge-podge of resources
> https://github.com/apache/cloudstack-docs-install.git is the install
> guide https://github.com/apache/cloudstack-docs-admin.git is the
> current admin manual.
> https://github.com/apache/cloudstack-docs-rn.git is the release notes
> for individual releases
>
> [2] https://beta-cloudstack-docs.readthedocs.io/en/latest/
>
> paul.angus@shapeblue.com
> www.shapeblue.com
> 53 Chandos Place, Covent Garden, London WC2N 4HSUK @shapeblue
>
>
>
>
Re: [PROPOSE] Combining Apache CloudStack Documentation
Posted by "Tutkowski, Mike" <Mi...@netapp.com>.
I like this, too, Paul.
On 7/24/18, 4:01 AM, "ilya musayev" <il...@gmail.com> wrote:
I like it but wonder if Upgrade section needs to be added? ..
On Tue, Jul 24, 2018 at 2:25 AM Paul Angus <pa...@shapeblue.com> wrote:
> Hi All,
>
> We currently have four sources of documentation [1]. Which make managing
> the documentation convoluted, and worse, make navigating and searching the
> documentation really difficult.
>
> I have taken the current documentation and combined them into one repo,
> then created 7 sections:
>
> CloudStack Concepts and Terminology
> Quick Installation Guide
> Installation Guide
> Usage Guide
> Developers Guide
> Plugins Guide
> Release Notes
>
> I haven't changed any of the content, but I've moved some of it around to
> make more sense (to me). You can see the result on RTD [2]
>
> I'd like to PROPOSE to move this demo version of the documentation over to
> the Apache repos and make it THE documentation source, update the website,
> and mark the current repos/sites as archive data.
>
> [1]
> https://github.com/apache/cloudstack-docs.git <
> https://github.com/apache/cloudstack-docs.git> is a bit of a dodge-podge
> of resources
> https://github.com/apache/cloudstack-docs-install.git is the install guide
> https://github.com/apache/cloudstack-docs-admin.git is the current admin
> manual.
> https://github.com/apache/cloudstack-docs-rn.git is the release notes for
> individual releases
>
> [2] https://beta-cloudstack-docs.readthedocs.io/en/latest/
>
> paul.angus@shapeblue.com
> www.shapeblue.com
> 53 Chandos Place, Covent Garden, London WC2N 4HSUK
> @shapeblue
>
>
>
>
Re: [PROPOSE] Combining Apache CloudStack Documentation
Posted by ilya musayev <il...@gmail.com>.
I like it but wonder if Upgrade section needs to be added? ..
On Tue, Jul 24, 2018 at 2:25 AM Paul Angus <pa...@shapeblue.com> wrote:
> Hi All,
>
> We currently have four sources of documentation [1]. Which make managing
> the documentation convoluted, and worse, make navigating and searching the
> documentation really difficult.
>
> I have taken the current documentation and combined them into one repo,
> then created 7 sections:
>
> CloudStack Concepts and Terminology
> Quick Installation Guide
> Installation Guide
> Usage Guide
> Developers Guide
> Plugins Guide
> Release Notes
>
> I haven't changed any of the content, but I've moved some of it around to
> make more sense (to me). You can see the result on RTD [2]
>
> I'd like to PROPOSE to move this demo version of the documentation over to
> the Apache repos and make it THE documentation source, update the website,
> and mark the current repos/sites as archive data.
>
> [1]
> https://github.com/apache/cloudstack-docs.git <
> https://github.com/apache/cloudstack-docs.git> is a bit of a dodge-podge
> of resources
> https://github.com/apache/cloudstack-docs-install.git is the install guide
> https://github.com/apache/cloudstack-docs-admin.git is the current admin
> manual.
> https://github.com/apache/cloudstack-docs-rn.git is the release notes for
> individual releases
>
> [2] https://beta-cloudstack-docs.readthedocs.io/en/latest/
>
> paul.angus@shapeblue.com
> www.shapeblue.com
> 53 Chandos Place, Covent Garden, London WC2N 4HSUK
> @shapeblue
>
>
>
>
AW: [PROPOSE] Combining Apache CloudStack Documentation
Posted by "Swen - swen.io" <me...@swen.io>.
Hi Paul,
thank you for this! I like it.
Best regards,
Swen
-----Ursprüngliche Nachricht-----
Von: Paul Angus [mailto:paul.angus@shapeblue.com]
Gesendet: Dienstag, 24. Juli 2018 11:25
An: dev@cloudstack.apache.org; users@cloudstack.apache.org
Betreff: [PROPOSE] Combining Apache CloudStack Documentation
Hi All,
We currently have four sources of documentation [1]. Which make managing the documentation convoluted, and worse, make navigating and searching the documentation really difficult.
I have taken the current documentation and combined them into one repo, then created 7 sections:
CloudStack Concepts and Terminology
Quick Installation Guide
Installation Guide
Usage Guide
Developers Guide
Plugins Guide
Release Notes
I haven't changed any of the content, but I've moved some of it around to make more sense (to me). You can see the result on RTD [2]
I'd like to PROPOSE to move this demo version of the documentation over to the Apache repos and make it THE documentation source, update the website, and mark the current repos/sites as archive data.
[1]
https://github.com/apache/cloudstack-docs.git <https://github.com/apache/cloudstack-docs.git> is a bit of a dodge-podge of resources https://github.com/apache/cloudstack-docs-install.git is the install guide https://github.com/apache/cloudstack-docs-admin.git is the current admin manual.
https://github.com/apache/cloudstack-docs-rn.git is the release notes for individual releases
[2] https://beta-cloudstack-docs.readthedocs.io/en/latest/
paul.angus@shapeblue.com
www.shapeblue.com
53 Chandos Place, Covent Garden, London WC2N 4HSUK @shapeblue
Re: [PROPOSE] Combining Apache CloudStack Documentation
Posted by ilya musayev <il...@gmail.com>.
I like it but wonder if Upgrade section needs to be added? ..
On Tue, Jul 24, 2018 at 2:25 AM Paul Angus <pa...@shapeblue.com> wrote:
> Hi All,
>
> We currently have four sources of documentation [1]. Which make managing
> the documentation convoluted, and worse, make navigating and searching the
> documentation really difficult.
>
> I have taken the current documentation and combined them into one repo,
> then created 7 sections:
>
> CloudStack Concepts and Terminology
> Quick Installation Guide
> Installation Guide
> Usage Guide
> Developers Guide
> Plugins Guide
> Release Notes
>
> I haven't changed any of the content, but I've moved some of it around to
> make more sense (to me). You can see the result on RTD [2]
>
> I'd like to PROPOSE to move this demo version of the documentation over to
> the Apache repos and make it THE documentation source, update the website,
> and mark the current repos/sites as archive data.
>
> [1]
> https://github.com/apache/cloudstack-docs.git <
> https://github.com/apache/cloudstack-docs.git> is a bit of a dodge-podge
> of resources
> https://github.com/apache/cloudstack-docs-install.git is the install guide
> https://github.com/apache/cloudstack-docs-admin.git is the current admin
> manual.
> https://github.com/apache/cloudstack-docs-rn.git is the release notes for
> individual releases
>
> [2] https://beta-cloudstack-docs.readthedocs.io/en/latest/
>
> paul.angus@shapeblue.com
> www.shapeblue.com
> 53 Chandos Place, Covent Garden, London WC2N 4HSUK
> @shapeblue
>
>
>
>
Re: [PROPOSE] Combining Apache CloudStack Documentation
Posted by Marc-Aurèle Brothier <ma...@brothier.org>.
I like the idea and the RTD. Thanks Paul for moving the data around.
On Wed, Jul 25, 2018 at 11:10 AM, Rohit Yadav <ro...@shapeblue.com>
wrote:
> +1 I like it, I'm okay with release notes being a separate (version
> specific) document/website.
>
>
> - Rohit
>
> <https://cloudstack.apache.org>
>
>
>
> ________________________________
> From: Paul Angus <pa...@shapeblue.com>
> Sent: Tuesday, July 24, 2018 2:55:26 PM
> To: dev@cloudstack.apache.org; users@cloudstack.apache.org
> Subject: [PROPOSE] Combining Apache CloudStack Documentation
>
> Hi All,
>
> We currently have four sources of documentation [1]. Which make managing
> the documentation convoluted, and worse, make navigating and searching the
> documentation really difficult.
>
> I have taken the current documentation and combined them into one repo,
> then created 7 sections:
>
> CloudStack Concepts and Terminology
> Quick Installation Guide
> Installation Guide
> Usage Guide
> Developers Guide
> Plugins Guide
> Release Notes
>
> I haven't changed any of the content, but I've moved some of it around to
> make more sense (to me). You can see the result on RTD [2]
>
> I'd like to PROPOSE to move this demo version of the documentation over to
> the Apache repos and make it THE documentation source, update the website,
> and mark the current repos/sites as archive data.
>
> [1]
> https://github.com/apache/cloudstack-docs.git <https://github.com/apache/
> cloudstack-docs.git> is a bit of a dodge-podge of resources
> https://github.com/apache/cloudstack-docs-install.git is the install guide
> https://github.com/apache/cloudstack-docs-admin.git is the current admin
> manual.
> https://github.com/apache/cloudstack-docs-rn.git is the release notes for
> individual releases
>
> [2] https://beta-cloudstack-docs.readthedocs.io/en/latest/
>
> paul.angus@shapeblue.com
> www.shapeblue.com<http://www.shapeblue.com>
> 53 Chandos Place, Covent Garden, London WC2N 4HSUK
> @shapeblue
>
>
>
>
> rohit.yadav@shapeblue.com
> www.shapeblue.com
> 53 Chandos Place, Covent Garden, London WC2N 4HSUK
> @shapeblue
>
>
>
>
Re: [PROPOSE] Combining Apache CloudStack Documentation
Posted by Rohit Yadav <ro...@shapeblue.com>.
+1 I like it, I'm okay with release notes being a separate (version specific) document/website.
- Rohit
<https://cloudstack.apache.org>
________________________________
From: Paul Angus <pa...@shapeblue.com>
Sent: Tuesday, July 24, 2018 2:55:26 PM
To: dev@cloudstack.apache.org; users@cloudstack.apache.org
Subject: [PROPOSE] Combining Apache CloudStack Documentation
Hi All,
We currently have four sources of documentation [1]. Which make managing the documentation convoluted, and worse, make navigating and searching the documentation really difficult.
I have taken the current documentation and combined them into one repo, then created 7 sections:
CloudStack Concepts and Terminology
Quick Installation Guide
Installation Guide
Usage Guide
Developers Guide
Plugins Guide
Release Notes
I haven't changed any of the content, but I've moved some of it around to make more sense (to me). You can see the result on RTD [2]
I'd like to PROPOSE to move this demo version of the documentation over to the Apache repos and make it THE documentation source, update the website, and mark the current repos/sites as archive data.
[1]
https://github.com/apache/cloudstack-docs.git <https://github.com/apache/cloudstack-docs.git> is a bit of a dodge-podge of resources
https://github.com/apache/cloudstack-docs-install.git is the install guide
https://github.com/apache/cloudstack-docs-admin.git is the current admin manual.
https://github.com/apache/cloudstack-docs-rn.git is the release notes for individual releases
[2] https://beta-cloudstack-docs.readthedocs.io/en/latest/
paul.angus@shapeblue.com
www.shapeblue.com<http://www.shapeblue.com>
53 Chandos Place, Covent Garden, London WC2N 4HSUK
@shapeblue
rohit.yadav@shapeblue.com
www.shapeblue.com
53 Chandos Place, Covent Garden, London WC2N 4HSUK
@shapeblue
Re: [PROPOSE] Combining Apache CloudStack Documentation
Posted by Rohit Yadav <ro...@shapeblue.com>.
+1 I like it, I'm okay with release notes being a separate (version specific) document/website.
- Rohit
<https://cloudstack.apache.org>
________________________________
From: Paul Angus <pa...@shapeblue.com>
Sent: Tuesday, July 24, 2018 2:55:26 PM
To: dev@cloudstack.apache.org; users@cloudstack.apache.org
Subject: [PROPOSE] Combining Apache CloudStack Documentation
Hi All,
We currently have four sources of documentation [1]. Which make managing the documentation convoluted, and worse, make navigating and searching the documentation really difficult.
I have taken the current documentation and combined them into one repo, then created 7 sections:
CloudStack Concepts and Terminology
Quick Installation Guide
Installation Guide
Usage Guide
Developers Guide
Plugins Guide
Release Notes
I haven't changed any of the content, but I've moved some of it around to make more sense (to me). You can see the result on RTD [2]
I'd like to PROPOSE to move this demo version of the documentation over to the Apache repos and make it THE documentation source, update the website, and mark the current repos/sites as archive data.
[1]
https://github.com/apache/cloudstack-docs.git <https://github.com/apache/cloudstack-docs.git> is a bit of a dodge-podge of resources
https://github.com/apache/cloudstack-docs-install.git is the install guide
https://github.com/apache/cloudstack-docs-admin.git is the current admin manual.
https://github.com/apache/cloudstack-docs-rn.git is the release notes for individual releases
[2] https://beta-cloudstack-docs.readthedocs.io/en/latest/
paul.angus@shapeblue.com
www.shapeblue.com<http://www.shapeblue.com>
53 Chandos Place, Covent Garden, London WC2N 4HSUK
@shapeblue
rohit.yadav@shapeblue.com
www.shapeblue.com
53 Chandos Place, Covent Garden, London WC2N 4HSUK
@shapeblue