Re: [PROPOSE] Combining Apache CloudStack Documentation

2018-07-25 Thread Rohit Yadav 
+1 I like it, I'm okay with release notes being a separate (version specific) 
document/website.


- Rohit






From: Paul Angus 
Sent: Tuesday, July 24, 2018 2:55:26 PM
To: dev@cloudstack.apache.org; us...@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 
 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.an...@shapeblue.com
www.shapeblue.com
53 Chandos Place, Covent Garden, London  WC2N 4HSUK
@shapeblue




rohit.ya...@shapeblue.com 
www.shapeblue.com
53 Chandos Place, Covent Garden, London  WC2N 4HSUK
@shapeblue

Re: [PROPOSE] Combining Apache CloudStack Documentation

2018-07-24 Thread Tutkowski, Mike 
I like this, too, Paul.

On 7/24/18, 4:01 AM, "ilya musayev"  wrote:

I like it but wonder if Upgrade section needs to be added? ..

On Tue, Jul 24, 2018 at 2:25 AM Paul Angus  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.an...@shapeblue.com
> www.shapeblue.com
> 53 Chandos Place, Covent Garden, London  WC2N 4HSUK
> @shapeblue
>
>
>
>

RE: [PROPOSE] Combining Apache CloudStack Documentation

2018-07-24 Thread Paul Angus 
We can certainly split them out from release notes quite easily


Kind regards,

Paul Angus

paul.an...@shapeblue.com 
www.shapeblue.com
53 Chandos Place, Covent Garden, London  WC2N 4HSUK
@shapeblue
  
 


-Original Message-
From: ilya musayev  
Sent: 24 July 2018 11:02
To: dev@cloudstack.apache.org
Cc: us...@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  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.an...@shapeblue.com
> www.shapeblue.com
> 53 Chandos Place, Covent Garden, London  WC2N 4HSUK @shapeblue
>
>
>
>

Re: [PROPOSE] Combining Apache CloudStack Documentation

2018-07-24 Thread ilya musayev 
I like it but wonder if Upgrade section needs to be added? ..

On Tue, Jul 24, 2018 at 2:25 AM Paul Angus  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.an...@shapeblue.com
> www.shapeblue.com
> 53 Chandos Place, Covent Garden, London  WC2N 4HSUK
> @shapeblue
>
>
>
>