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/08/17 16:35:52 UTC
RE: Combining Apache CloudStack Documentation
HI All,
My Todo list is pretty much complete, I just need to ask infra to set up a webhook.
So to sum up
- The consolidated documentation is live at http://docs.cloudstack.apache.org
- The website points to the new documentation location and has links to the 'archived' documentation
- The old documentation has a warning notices on Read The Docs and on the Github Readme
Kind regards,
Paul Angus
paul.angus@shapeblue.com
www.shapeblue.com
53 Chandos Place, Covent Garden, London WC2N 4HSUK
@shapeblue
From: Paul Angus
Sent: 27 July 2018 15:18
To: dev <de...@cloudstack.apache.org>; users@cloudstack.apache.org
Subject: Combining Apache CloudStack Documentation
Hi All,
Thank you to everyone for their appreciation of this little project. In line with that and a couple of the comments, I've tweaked and added some links and fixed a load of internal links and references within the docs.
I've had a new repo created under our project [1] and linked it to ReadTheDocs [2]. I've been through all of the RTD settings and applied the same as the original ones had - including adding all of the existing maintainers. It's just missing a web-hook, which I think infra will need to sort.
I've also done a load of work in the 'Doc Writers' section of the cwiki [3], to make getting started easier for people.
The 'new style' documentation is open for business wrt pull requests and merges by community people - so please get stuck in.
For anyone who is used to working with our documentation, please have a look at the Advanced Information section of [4] as it explains a couple of backend things that I've done, you should find that it makes things easier, but it explains why they're there and how they work.
[1] https://github.com/apache/cloudstack-documentation
[2] https://cloudstack-documentation.readthedocs.io/
[3] https://cwiki.apache.org/confluence/display/CLOUDSTACK/Doc+Writers?src=breadcrumbs-parent
[4] https://cwiki.apache.org/confluence/display/CLOUDSTACK/Getting+Started+Writing+Documentation
I'm on holiday with the family for a couple of weeks.
My TODO list when I return is:
- Update website to reflect new documentation location + 'pre 4.11 documentation'
- update the redirect from http://docs.cloudstack.apache.org to the new location.
- add webhook to github repo to trigger builds when a commit happens
- Update pre 4.11 docs to make it clear that 4.11+ exists and add a link
- Make it clear on github that updates should be in new repo (maybe make readonly)
- port across any updates made to the old docs to the new docs during transition.
Kind regards,
Paul Angus
Re: Combining Apache CloudStack Documentation
Posted by Rohit Yadav <ro...@shapeblue.com>.
Great work Paul. Used this myself for referencing something, it was good to have everything on the same site.
- Rohit
<https://cloudstack.apache.org>
________________________________
From: Paul Angus <pa...@shapeblue.com>
Sent: Friday, August 17, 2018 10:05:52 PM
To: dev; users@cloudstack.apache.org
Subject: RE: Combining Apache CloudStack Documentation
HI All,
My Todo list is pretty much complete, I just need to ask infra to set up a webhook.
So to sum up
- The consolidated documentation is live at http://docs.cloudstack.apache.org
- The website points to the new documentation location and has links to the 'archived' documentation
- The old documentation has a warning notices on Read The Docs and on the Github Readme
Kind regards,
Paul Angus
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
Amadeus House, Floral Street, London WC2E 9DPUK
@shapeblue
From: Paul Angus
Sent: 27 July 2018 15:18
To: dev <de...@cloudstack.apache.org>; users@cloudstack.apache.org
Subject: Combining Apache CloudStack Documentation
Hi All,
Thank you to everyone for their appreciation of this little project. In line with that and a couple of the comments, I've tweaked and added some links and fixed a load of internal links and references within the docs.
I've had a new repo created under our project [1] and linked it to ReadTheDocs [2]. I've been through all of the RTD settings and applied the same as the original ones had - including adding all of the existing maintainers. It's just missing a web-hook, which I think infra will need to sort.
I've also done a load of work in the 'Doc Writers' section of the cwiki [3], to make getting started easier for people.
The 'new style' documentation is open for business wrt pull requests and merges by community people - so please get stuck in.
For anyone who is used to working with our documentation, please have a look at the Advanced Information section of [4] as it explains a couple of backend things that I've done, you should find that it makes things easier, but it explains why they're there and how they work.
[1] https://github.com/apache/cloudstack-documentation
[2] https://cloudstack-documentation.readthedocs.io/
[3] https://cwiki.apache.org/confluence/display/CLOUDSTACK/Doc+Writers?src=breadcrumbs-parent
[4] https://cwiki.apache.org/confluence/display/CLOUDSTACK/Getting+Started+Writing+Documentation
I'm on holiday with the family for a couple of weeks.
My TODO list when I return is:
- Update website to reflect new documentation location + 'pre 4.11 documentation'
- update the redirect from http://docs.cloudstack.apache.org to the new location.
- add webhook to github repo to trigger builds when a commit happens
- Update pre 4.11 docs to make it clear that 4.11+ exists and add a link
- Make it clear on github that updates should be in new repo (maybe make readonly)
- port across any updates made to the old docs to the new docs during transition.
Kind regards,
Paul Angus
Re: Combining Apache CloudStack Documentation
Posted by Rohit Yadav <ro...@shapeblue.com>.
Great work Paul. Used this myself for referencing something, it was good to have everything on the same site.
- Rohit
<https://cloudstack.apache.org>
________________________________
From: Paul Angus <pa...@shapeblue.com>
Sent: Friday, August 17, 2018 10:05:52 PM
To: dev; users@cloudstack.apache.org
Subject: RE: Combining Apache CloudStack Documentation
HI All,
My Todo list is pretty much complete, I just need to ask infra to set up a webhook.
So to sum up
- The consolidated documentation is live at http://docs.cloudstack.apache.org
- The website points to the new documentation location and has links to the 'archived' documentation
- The old documentation has a warning notices on Read The Docs and on the Github Readme
Kind regards,
Paul Angus
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
Amadeus House, Floral Street, London WC2E 9DPUK
@shapeblue
From: Paul Angus
Sent: 27 July 2018 15:18
To: dev <de...@cloudstack.apache.org>; users@cloudstack.apache.org
Subject: Combining Apache CloudStack Documentation
Hi All,
Thank you to everyone for their appreciation of this little project. In line with that and a couple of the comments, I've tweaked and added some links and fixed a load of internal links and references within the docs.
I've had a new repo created under our project [1] and linked it to ReadTheDocs [2]. I've been through all of the RTD settings and applied the same as the original ones had - including adding all of the existing maintainers. It's just missing a web-hook, which I think infra will need to sort.
I've also done a load of work in the 'Doc Writers' section of the cwiki [3], to make getting started easier for people.
The 'new style' documentation is open for business wrt pull requests and merges by community people - so please get stuck in.
For anyone who is used to working with our documentation, please have a look at the Advanced Information section of [4] as it explains a couple of backend things that I've done, you should find that it makes things easier, but it explains why they're there and how they work.
[1] https://github.com/apache/cloudstack-documentation
[2] https://cloudstack-documentation.readthedocs.io/
[3] https://cwiki.apache.org/confluence/display/CLOUDSTACK/Doc+Writers?src=breadcrumbs-parent
[4] https://cwiki.apache.org/confluence/display/CLOUDSTACK/Getting+Started+Writing+Documentation
I'm on holiday with the family for a couple of weeks.
My TODO list when I return is:
- Update website to reflect new documentation location + 'pre 4.11 documentation'
- update the redirect from http://docs.cloudstack.apache.org to the new location.
- add webhook to github repo to trigger builds when a commit happens
- Update pre 4.11 docs to make it clear that 4.11+ exists and add a link
- Make it clear on github that updates should be in new repo (maybe make readonly)
- port across any updates made to the old docs to the new docs during transition.
Kind regards,
Paul Angus