[contributor] Explain Project install guides

Add new section on project install guides.

Change-Id: Idb59c3a301b7b0993fd588865f7f241c00423030
Partially-Implements: blueprint projectspecificinstallguides
This commit is contained in:
Andreas Jaeger 2016-06-09 07:52:40 +02:00
parent df46b80495
commit 64a5b202ee
2 changed files with 46 additions and 0 deletions

View File

@ -25,6 +25,7 @@ Contents
docs-structure.rst
content-specs.rst
api-guides.rst
project-install-guide
topic-structure.rst
topic-tags.rst
writing-style.rst

View File

@ -0,0 +1,45 @@
===============================
Project specific install guides
===============================
Project specific installation guides can be set up as follows:
* Use the ``installguide-cookiecutter
<https://git.openstack.org/cgit/openstack/installguide-cookiecutter>``
cookiecutter to create a skeleton for your project.
This adds content to the ``install-guide`` directory in the
top-level of the project repository.
* Include a ``tox.ini`` environment for 'install-guide':
.. code::
[testenv:install-guide]
# NOTE(jaegerandi): this target does not use constraints because
# upstream infra does not yet support it. Once that's fixed, we can
# drop the install_command.
install_command = pip install -U --force-reinstall {opts} {packages}
commands = sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html
* Add the python package ``openstackdocs-theme`` to the
``test-requirements.txt`` file.
* Once the changes above are merged, add jobs for it in the
``openstack-infra/project-config`` repository. Define the jobs using
the JJB ``install-guide-jobs`` job-template in file
``jenkins/jobs/projects.yaml`` like:
.. code-block:: yaml
...
- install-guide-jobs:
service: orchestration
Here ``service`` is the service name of the project, like
orchestration for heat.
Add the ``install-guide-jobs`` template to ``zuul/layout.yaml`` to
schedule the jobs.
* TBD: How to create master index file for this.