openstack/cinder
Code Issues Proposed changes
d5cd6f4736
cinder/doc/source/contributor/README.rst

18 lines
719 B
ReStructuredText
Raw Normal View History

[Docs] Add documentation contribution docs 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
2017-08-10 11:24:00 -05:00
=====================================================
Cinder Contributor Documentation (source/contributor)
=====================================================
Make doc/source directory compliant with design in spec 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
2017-07-19 15:21:07 -05:00
Introduction:
-------------
This directory is intended to hold any documentation that relates to
Fix some typos in cinder doc There are some typos in cinder doc, contirbute(contribute) ReplicationsSatus(ReplicationStatus) soure(source) specificed(specified) priviledged(privileged) overriden(overridden) This is to fix them. Change-Id: I2fb8317361ca574c49eb39e0b7735c7592126dc6
2017-12-19 13:46:05 +08:00
how to contribute to Cinder or how the project is managed. Some of this
Make doc/source directory compliant with design in spec 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
2017-07-19 15:21:07 -05:00
content was previous under 'developer' in openstack-manuals. The content
of the documentation, however, goes beyond just developers to anyone
contributing to the project, thus the change in naming.
The full spec for organization of documentation may be seen in the
`OS Manuals Migration Spec
<https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html>`.
Copy Permalink