Skip to content

Commit

Permalink
Merge "Remove placement from contributor doc"
Browse files Browse the repository at this point in the history
  • Loading branch information
Zuul authored and openstack-gerrit committed Feb 21, 2019
2 parents 841f02c + 1e3ed77 commit a37a035
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 13 deletions.
11 changes: 1 addition & 10 deletions doc/source/contributor/api-ref-guideline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@
API reference guideline
=======================

The API reference should be updated when compute or placement APIs are modified
The API reference should be updated when compute APIs are modified
(microversion is bumped, etc.).
This page describes the guideline for updating the API reference.

API reference
=============

* `Compute API reference <https://developer.openstack.org/api-ref/compute/>`_
* `Placement API reference <https://developer.openstack.org/api-ref/placement/>`_

The guideline to write the API reference
========================================
Expand All @@ -24,14 +23,6 @@ Compute API reference
* Parameter definition: ``api-ref/source/parameters.yaml``
* JSON request/response samples: ``doc/api_samples/*``

Placement API reference
-----------------------

The placement project has the API reference files in its own repository
under `api-ref/source
<https://github.com/openstack/placement/tree/master/api-ref/source>`_
directory.

Structure of inc file
---------------------

Expand Down
1 change: 0 additions & 1 deletion doc/source/contributor/how-to-get-involved.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@ Here are some top tips around engaging with the Nova community:
- IRC

- we talk a lot in #openstack-nova
- we also have #openstack-placement for :placement-doc:`placement <>`
- do ask us questions in there, and we will try to help you
- not sure about asking questions? feel free to listen in around
other people's questions
Expand Down
2 changes: 0 additions & 2 deletions doc/source/contributor/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,4 @@ Major subsystems in nova have different needs; some of those are documented
here. If you are contributing to one of these please read the subsystem guide
before diving in.

* :placement-doc:`Placement API Developer Notes <contributor/index>`

* :doc:`/user/conductor`

0 comments on commit a37a035

Please sign in to comment.