Commit Graph

12 Commits

Author SHA1 Message Date
Sean Mooney 25fd9effd2 [codespell] doc,devstack and gate typos
Change-Id: I919e24a1b4dea394d35b845d44cddee9c762b268
2023-10-03 01:32:42 +01:00
Rajesh Tailor 0fce3c03ab Fix typos in nova docs
Change-Id: I7b6f8c198aa42f5ef3f8b158308b993b040454ec
2022-09-23 09:09:37 +05:30
Andreas Jaeger dbe6321537 Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that Neutron publishes to api-ref/network, not networking anymore.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: Id2cf3aa252df6db46575b5988e4937ecfc6792bb
2019-07-22 19:17:28 +02:00
Takashi NATSUME d078b95b59 Add description about sort order in API ref guideline
Add a description about sort order of response results in
the API reference guideline.

Change-Id: I458795a4f745a0699bc8de40aaa2b3c03c762422
Partial-Bug: #1793034
2019-03-22 06:33:21 +00:00
Chris Dent 1e3ed770ef Remove placement from contributor doc
Placement has its own contributor documentation.

Change-Id: I13070ee66eb2ecce9ce68fd6e5f3f62743437c6a
2019-02-07 10:40:00 +00:00
Takashi NATSUME 64f97177c5 Follow up for "Add API ref guideline for body text"
This patch is a follow-up for
Ib03b562ffe189f24293eb77dd0c0ed5ec679172a.

Change-Id: I7a8a8d64dfc49b1e15135259388285ceeae2fb2c
2019-01-07 05:51:35 +00:00
Takashi NATSUME 09fc91a070 Add descriptions about microversions
This patch is a follow-up patch
for I3e1ca88cac3a52a8b44e26f051a51a6db77a3231.

Add descriptions about microversions in the parameter section
in the API reference guideline.

Change-Id: I266d44cf96945445115b843aacbc29083e21bd8e
2018-12-16 23:29:50 +00:00
Takashi NATSUME 2a3e7affea Add API ref guideline for body text
Add guideline for body text in the API reference.

Change-Id: Ib03b562ffe189f24293eb77dd0c0ed5ec679172a
Partial-Bug: #1793034
2018-12-09 23:46:13 +00:00
Takashi NATSUME 311110e81b Remove Placement API reference
The placement project has published the API reference
in its own repository and the related jobs for the nova project
has been removed since Ia4680f24d78af1260f2f0106a458b78a079c1287.

So remove the files and definitions related to
the placement API reference in the nova repository.

Change-Id: Ia43b958a28e7e763e7ecb29e06f8d21d2b9a850f
2018-11-28 03:38:41 +00:00
Takashi NATSUME e023146ad6 Add a link to the doc contrib guide
Add a link to the
"How to document your OpenStack API service" section
of the documentation contributor guide
in the nova API reference guideline.

Change-Id: I0d2889b63528c4d39820011746d92732440499e9
2018-11-07 13:19:30 +09:00
Takashi NATSUME 8ad33f35a4 Add API ref guideline for examples
Add guideline for JSON request/response body examples
in the API reference.

Change-Id: I2dcc2fc1a16cc5dcba7879518a2b101df3576304
2018-10-25 07:46:48 +00:00
Takashi NATSUME 6f4ec5419d Add the guideline to write API reference
Adapted from the wiki:
https://wiki.openstack.org/wiki/NovaAPIRef

Compute API reference:
https://developer.openstack.org/api-ref/compute/

Placement API reference:
https://developer.openstack.org/api-ref/placement/

Change-Id: I78ded463142fc50af3b77721500ed190448632c7
2018-08-08 12:15:15 -04:00