Add a flag to tell us which projects have a .htaccess file in their
doc build output.
Change-Id: I0af0e32d9c646d61f4c72599cdc4613299aa5ec9
Depends-On: I236b7b0a9aae065167bd0aef316603d258e4c3c6
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This patch addresses the comments left on
I9f98c78bc4b13ea64b6cb96537e81b69267905b1 when it was approved.
Change-Id: Ica64f8f1537dbcfbc943b9f478820ac9785279f0
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Move the docs for the template generator input files to the
contributor guide. Expand the docs to explain the template variables
and the data set within the generator code.
Change-Id: I9f98c78bc4b13ea64b6cb96537e81b69267905b1
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Reformat the plain text file as valid RST, then include it in the
contributor guide instead of just linking to it.
Change-Id: I5992cec2250977c5ec8e809a837bb4404da869ed
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
First version of moving some content from the migration spec to the
Contributor Guide to serve as reference on how projects should set up
their directories.
It also explains how to link to the landing pages.
Change-Id: I9c815650a19d6d67d89301fa36d795c590be331d
Remove watermark for pike. This allows to remove sphinxmark extension
usage, so remove it and pillow from test-requirements and update
contributor-guide for this.
Explain that guide handles Pike release now.
Change-Id: Ib1c71971b822cc0aa3e6531b2d5607714551d9db
Update the instructions for managing the end of the release to remove
obsolete steps and to include instructions for setting up the new
templates.
Change-Id: Ifc626faa82e403a04ae18297efc8ec280b9db0ee
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The useful content in the user guide is all being moved to
project-specific docsets. We can remove the guide here, and replace it
with a /user/ landing page that provides links to all of the known user
guides for services and clients.
Change-Id: I7005b4288b94e755f406fd6a8e3273265b643042
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Update the instructions to indicate which guides are no longer
maintained by the docs team and how those docs are handled instead.
Explain the data input to the www-generator.py tool
Update the release instructions to explain how to update the templated
portion of the site.
Change-Id: I08bb228a6807bfcee0a6ab72ddaf229b455c9d1d
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The openstackdocstheme requires now setting of bug_project, set it up
everywhere.
Change-Id: I778800b8944e3e1d89cdbd1f844c5830a94012d6
Depends-On: Ifd715d1d46d1b1796d79679c9e954d21e9d09455
With the new openstackdocstheme used, we can simplify conf.py.
Also, update our docs for it.
Note that Sphinx 1.6 needs latexmk for building, add it.
Sphinx 1.6 introduces a few new warnings, fix them so that the guides
built.
Change-Id: If2e431725eb54f8be79b9fa4bf9ede2089f321a5
Trivial fix
speciality -> specialty
can't -> cannot
it's -> it is
These changes are in accordance to the
contributor-guide which guides to use standard
U.S. English and to avoid using contractions
Change-Id: Icf5616cbe012f166630befab796377ec9b3b9d5e
Adds guidelines for the docs:follows-policy tag.
Change-Id: Ic7c9447ca4c992f645eace08747dd37a71e42218
Depends-on: Id8e2c544856aca712588b7c08e099d16144ad4f3
While this may look like a noop change, it removes an invalid character
that was causing the checkniceness tests to fail. We can also now unpin
the chardet library.
Change-Id: Iaa4e7069187d048ad375376c25b1de4b142b62ad
Update instructions to include the need to update links to draft optional
services guides in the basic Install Tutorial.
Change-Id: Ib22d1237e1d82073775929e43df0f35db727b6c7
Partial-Bug: #1677234
Move glossary and appendix in one chapter called appendix.
This has been done already for arch-design and ops-guide, do it for the
other guides. Share common appendix.
Change-Id: I6bf4e94f6c0569850cca6558be672de298bb208c
Version numbers will be used in PDFs such as
"Release Version: 15.0" following short X.Y version.
Note that Ocata is 15th release.
Change-Id: I6a11992e819626f3b4f4360222521795f7e3b74d
With the change to search.html, the search page now
searches docs.openstack.org, not the specific guide.
Update the header to reflect this.
Change-Id: I9cb4b7669e4c0767e73b105867240a1079d0c086