openstack/openstack-manuals
Code Issues Proposed changes

Merge "Update the outdated content about project API reference"

Browse Source
This commit is contained in:
Zuul 2018-07-05 13:39:28 +00:00 committed by Gerrit Code Review
commit 5bbbadcc38
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/doc-contrib-guide/source/api-guides.rst
View File

@ -164,15 +164,16 @@ The basic steps are:
$ tox -e api-ref
#. Create a build job similar to the nova job for your project. Examples:
https://review.openstack.org/#/c/305464/ and
https://review.openstack.org/#/c/305485/.
#. Add the ``api-ref-jobs`` template to your project, patch the
`zuul.d/projects.yaml <https://git.openstack.org/cgit/openstack-infra/project-config/tree/zuul.d/projects.yaml>`__
file stored in ``openstack-infra/project-config`` repository.
After the source files and build jobs exist, the docs are built to
`developer.openstack.org`_.
If your document is completely new, you need to add links to it from the API
landing page and the OpenStack Governance reference document, projects.yaml.
landing page and the OpenStack Governance reference document,
``projects.yaml``.
To add a link to the project's API docs to the API landing page, patch the
``index.rst`` file stored in the `openstack/api-site repository`_.