[OpenStack-docs] Change of doc publishing

Lana Brindley openstack at lanabrindley.com
Fri Aug 26 02:07:51 UTC 2016


On 24/08/16 06:14, Andreas Jaeger wrote:
> Hi Docs team,
> 
> some time ago, we discussed with the infra team to move docs publishing
> for developer.openstack.org and docs.openstack.org from RackSpace
> CloudSites to pages under OpenStack Infra control.
> 
> At that time the following spec was written but never implemented:
> http://specs.openstack.org/openstack-infra/infra-specs/specs/doc-publishing.html
> 
> Now, the infra team is planning to take this on  - and Jim Blair updated
> the specs to use AFS (Andrew File System) for it:
> 
> https://review.openstack.org/276482

Yay!

> 
> A side benefit of the proposed spec is that stale files can get removed.

More yay!

> 
> Since docs.openstack.org is mainly controlled by us, I'd like us all to
> review the spec and comment.

I have now done this thing.

> 
> Also, there's the question of migration and policy on retaining old
> documentation. Right now for our own documents, we remove (disable/add
> redirects) - but for projects, we keep them around forever. As an
> example, take a look at this document from December 2012:
> http://docs.openstack.org/developer/cinder/2012.2.1/
> 
> Note that it's very difficult to regenerate such old content - and
> nobody knows about it since there are no direct links to it.
> 
> So, moving forward, what policy do you suggest to have on content:
> 
> * Support all old releases - or only the active branches (with some
> grace period), so right now Liberty, Mitaka, Master (and perhaps Kilo
> for grace period)?

I like the idea of just migrating and supporting current releases. Will we have some way of archiving old content in a static way somehow, though?

> * Migrate *all* content? Or only the content as specified above? Or
> start with a clean slate and let the site get filled for a few weeks
> from generated content?
> * Continue to support only official OpenStack projects (as listed in
> governance repo)?
> * ...
> 
> What are the best policies here? What did I miss?
> 
> Btw. Jim is looking for volunteers to help with the spec, if you're
> interested in a task, please comment on the review and sign up,

Thanks for the update, Andreas. I've added a small note into this week's newsletter on this topic too.

Lana

-- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 538 bytes
Desc: OpenPGP digital signature
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160826/d7dafc60/attachment.pgp>


More information about the OpenStack-docs mailing list