..
 This work is licensed under a Creative Commons Attribution 3.0 Unported
 License.

 http://creativecommons.org/licenses/by/3.0/legalcode

===========================
Publishing of draft manuals
===========================

https://blueprints.launchpad.net/openstack-manuals/+spec/draft-publishing

Problem description
===================

Currently, the following guides are not published at all from the
master branch of the git repository:

* Networking Guide
* Install Guide
* RST User Guides (will change while we discuss this spec)

This makes it difficult for contributors to review current status.

We publish the Configuration reference to
http://docs.openstack.org/trunk/ .

We also have a trunk index page that speaks about "Draft" guides but
references also continuous publishing guides which might confuse users.

Another challenge is drafts of translated guides. Currently we do not
differentiate between fully translated guides and drafts, the only
difference is a link in the index page.

Proposed change
===============

#. Publish draft content to a special location like `/draft/`.
#. Create a single page that references all draft documents and only
   those, this page should be hidden. The page is `/draft/draft-index.html`
#. Remove the current `/trunk/index.html` page and links to it.
#. Take care that search machines do not index these pages.
#. Ensure that any partial translated pages do not publish to `/lang/trunk/`
   but instead to `/lang/draft`.

For translated content:

#. Publish draft translated content to `/draft/LANG/`.
#. Add the guides to `/draft/draft-index.html` index page.
#. Once guides are reviewed and fully translated , move the content to
   `/LANG/` and reference it from a public language specific index page.


Alternatives
------------

#. Keep status quo
#. Publish to another location like `/trunk/`.

Implementation
==============

* Change location of publishing.
* Remove `/trunk/index.html` and links to it.
* Add `/draft/` to :file:`robots.txt`.
* Create new `/draft/draft-index.html` page.
* Review translated documents and publish draft translated documents
  to `/draft/LANG/` and add links to `/draft/draft-index.html`.
* Remove old pages.
* Regenerate sitemap.

Assignee(s)
-----------

jaegerandi

Work Items
----------

See implementation.

Dependencies
============

None.

Testing
=======

* Test by going to /trunk and making sure redirect is in place.
* Search for draft content to make sure it's not found.


References
==========

* http://lists.openstack.org/pipermail/openstack-docs/2015-April/006243.html

* https://docs.google.com/spreadsheets/d/10HD6iW1CtfB1qT2wVODYiHdC0ysr4xw392VCqHB-aaY/edit?usp=sharing