Merge "[upstream] add basic slides about openstack documentation"

This commit is contained in:
Jenkins 2016-10-24 13:02:14 +00:00 committed by Gerrit Code Review
commit 72212bc406
3 changed files with 80 additions and 0 deletions

View File

@ -0,0 +1,66 @@
=======================
OpenStack Documentation
=======================
.. image:: ./_assets/os_background.png
:class: fill
:width: 100%
Mission
=======
- Provide documentation for core OpenStack projects to promote OpenStack.
- Develop and maintain tools and processes to ensure quality, accurate
documentation.
- Treat documentation like OpenStack code.
Sites
=====
- http://docs.openstack.org
- http://developer.openstack.org
Specialty teams
===============
- API
- Configuration Reference and CLI Reference
- High Availability Guide
- Hypervisor Tuning Guide
- Installation guides
- Networking Guide
- Operations and Architecture Design guides
- Security Guide
- Training guides
- Training labs
- User guides
Repositories
============
- ``docs-specs``
- ``openstack-doc-tools``
- ``openstack-manuals``
- ``openstackdocstheme``
- ``security-doc``
- ``training-guides``
- ``training-labs``
Bug reports
===========
- https://bugs.launchpad.net/openstack-manuals
- https://bugs.launchpad.net/openstack-api-site
Contributor guide
=================
- http://docs.openstack.org/contributor-guide/index.html
This guide provides detailed instructions on the contribution workflow and
conventions to be considered by all documentation contributors.
Building documentation
======================
- http://docs.openstack.org/contributor-guide/docs-builds.html

View File

@ -56,6 +56,15 @@ Code Deep Dive
code-exercises.rst
branching-model.rst
Documentation Deep Dive
=======================
.. toctree::
:maxdepth: 1
docs.rst
Archive
=======

View File

@ -134,6 +134,11 @@ Code Deep Dive
* `Demo environment <code-devstack.html>`_
* `Code exercises <code-exercises.html>`_
Other
-----------------------
* `Documentation Deep Dive <docs.html>`_
Archive of additional training activities
-----------------------------------------