85107272be
Based off conversation at the PTG, we agreed it would be beneficial to ensure the contrib-guide is clearly marked as the doc contrib guide outside of the title. This change includes a redirect. Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
25 lines
963 B
ReStructuredText
25 lines
963 B
ReStructuredText
.. _new_projects:
|
|
|
|
============
|
|
New projects
|
|
============
|
|
|
|
If you are maintaining a new project that has recently been accepted into the
|
|
OpenStack 'big tent' then you will require some documentation for your
|
|
project.
|
|
|
|
Documentation for your project should live in your project's
|
|
git repository, and be published to `docs.openstack.org/yourproject`.
|
|
If you need to create that index page, you will also need to add the
|
|
``openstack-unified-publish-jobs`` to the appropriate repositories by
|
|
updating the settings in the ``project-config`` repository so that the
|
|
documentation is re-published with every commit.
|
|
|
|
Any configuration options or command line tools should be documented using
|
|
the automated ``openstack-doc-tools``. For more information about these
|
|
automated tools, see the :ref:`doc-tools` chapter.
|
|
|
|
To create an Installation Tutorial in accordance with the OpenStack
|
|
Foundation Project Navigator, follow the instructions at
|
|
:ref:`project-install-guide`.
|