Commit Graph

8 Commits

Author SHA1 Message Date
Zuul 2d3b204d38 Merge "Add contributor docs on deprecating and removing compute REST APIs" 2018-06-06 21:01:04 +00:00
Matt Riedemann d5202b5561 Add contributor docs on deprecating and removing compute REST APIs
Deprecating APIs with microversions is a long-established pattern
at this point, but the docs don't mention it at all, so this
adds a short description of what happens there.

We removed the os-certificates and os-cloudpipe APIs in Pike
and the os-fping API in Rocky, and there is a pattern to removal
also, so this adds detailed documentation on the steps involved
in removing a deprecated API.

Change-Id: I9fdb9ce78c45d27d3c7f55fcbda0f763dfb66d66
2018-05-14 10:12:40 -04:00
Zuul 4fa05ab6d4 Merge "[Doc]Link policies file into api" 2018-05-11 01:51:27 +00:00
jichen 936f765b85 [Doc]Link policies file into api
Link policies file into api.

Change-Id: I0afb7e850ad7064138ad2b69d0fa900d40f3efbe
2018-05-09 17:22:37 +08:00
jichen e285070ec7 Fix doc link for api
doc link has an issue.
Trivial Fix

Change-Id: I949711ebfc51a09bbdc344fa0e242b924e66a29f
2018-04-16 11:14:16 +08:00
Matt Riedemann 749f1ecbc5 Document testing guide for new API contributions
This fills in the TODOs for the unit, functional and
docs part of the API contributor guide.

Since we don't rely on the DocImpact tag in the commit
message for API changes (that tag results in a nova bug
and was meant mostly for making changes to docs external
to the nova repo, which is no longer the case), this
changes that section to just talk about the in-tree docs
that should be updated for API changes.

Change-Id: I9ca423c09185d2e3733357fd47aaba82d716eea4
2017-12-22 08:52:15 -05:00
ghanshyam 796f3036c2 Update api doc with latest updates in api framework
api.rst has many stale information now as we have done
many changes in api framework specially removal of
stevedore extensions loading and plain routing.

This commit modify this doc to reflect latest information
and remove v2 specific info which are no longer valid.

Note- in next part we will merge api_2.rst in this doc and
show 'adding api method' step by step.

Change-Id: I0628d8fa0b19c3fb09f1896402fc85dcae90916f
2017-08-15 07:02:40 +00:00
Stephen Finucane a2165cf651 doc: Populate the 'contributor' section
Per the spec [1]:

  contributor/ – anything related to contributing to the project or how
  the team is managed. Applies to some of the current content under
  /developer, we are changing the name to emphasize that not all
  contributors are developers and sometimes developers are users but not
  contributors.

We currently have a handful of docs that focus on the "how to develop or
contribute" aspects of nova, and these are moved. Docs that focus on
architecture or design decisions for nova are not moved, as these will
go into 'reference'.

A TODO is added to the former 'api_plugins' document as it's mega
out-of-date and needs some serious work.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: Iad770688b4eafeb9caa710b4398b02d80a017a70
2017-07-18 15:41:19 +01:00