Although we had some effort to fix these before, it still left lots
of outdated link address, this patch is to fix them all.
Change-Id: I2f9ee172306bf5a99575e0cb6f5eac0ea87b0483
Reorganizes and cleans up the docs landing page so viewers eyes don't
immediately start bleeding. Also tries to simplify things and put them
in a more logical and consumable order.
Change-Id: I1c3ee6ad21bd27a5ef7f6691ddd8dde25e9c4c01
Now that we are in charge of managing our documentation I thought
we should have a section in the Contributor Guide on
how to contribute documentation. This patch adds that.
It also resolves build WARNINGS due to the README files I added
not being included in any toctrees and adds the missing README
file to the install directory.
Change-Id: I8e12628b439a400ebd1ee6d691673a16e2c2f9d2
The following spec defines what each project's doc/source
directory is supposed to look like:
https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
I had not yet moved existing content to follow this design.
This patch does that, moving the devref to the
'contributor' directory. It also moves the CLI
related documentation into the 'cli' directory. I have
updated the autodoc generation to now create the api
documentation in 'doc/source/contributor/api'.
This patch also creates a template for future documentation
contribution. I have created all of the directories
recommended by the spec and have included documentation
as to what should go in each directory.
The index file is updated to point at the new locations for
existing content.
'doc/.gitignore' is updated so that it won't complain about the
automatically generated 'doc/contributor/api' directory.
Change-Id: I55c50fa0b7c1d06c91e40dbcfd11b1c8e8378aa6
