Commit Graph

11 Commits

Author SHA1 Message Date
Chris Dent d7145270c3 [placement] Add to contributor docs about handler testing
A recent IRC conversation [1] discussed that there are generally no tests
for the placement handler code (the wsgi methods that respond to each
URI and HTTP method). This change adds a paragraph to point out that
this is mostly intentional and that when they get complex it would
be a good idea to extract a method.

[1] http://eavesdrop.openstack.org/irclogs/%23openstack-nova/%23openstack-nova.2018-03-28.log.html#t2018-03-28T13:00:40

Change-Id: I09774c123068e42e6a828fc37455dc5d374486b9
2018-03-30 11:30:52 +01:00
Chris Dent eb637b9de7 Update contributor/placement.rst to contemporary reality
This udpates the placement contributor documentation to reflect the
current state of affairs. Ininitially this was just going to be an
update to reflect that the oslo versioned objects had moved. However,
while reviewing the rest of the doc it became clear there were other
issues that should be resolved. Doing so in one shot helps to maintain
the continuity of the document and doing it piecemeal means it is less
likely to happen.

Change-Id: Ia8d4861799e27a30108dd465d15828c5a1943819
2018-03-14 09:58:29 +00:00
Zuul db82a00a60 Merge "Fix the format file name" 2018-02-07 02:19:41 +00:00
Chris Dent 13e3aff7f1 Provide example for placement last-modified header of now
In the comments to I8f0c3006d1bb97d228f73256c58a79235cd12670, a request
for clarification was made on when the last-modified header should
be "now". This adds an example to help things a bit more clear.

Change-Id: I301f17bc7aad9f0037d2b13aa6e493ac9a6abb80
2017-12-20 15:22:49 +00:00
Chris Dent 413d50e78e [placement] Add info about last-modified to contrib docs
Add some instructions on how and when to add last-modified headers
when creating a new handler in the placement API.

Change-Id: I8f0c3006d1bb97d228f73256c58a79235cd12670
2017-12-12 15:53:26 +00:00
Luong Anh Tuan 5d2c8fa9e1 Fix the format file name
The file name should be marked follow [1]
as consistent with their semantic meaning.

[1] https://docs.openstack.org/doc-contrib-guide/rst-conv/inline-markups.html#file-name-and-path

Change-Id: Ic18d0563412650d3b42c2ed5c07e69f309877cb9
2017-11-27 11:43:41 +07:00
Zuul f7da17b8e3 Merge "[placement] Fix a wrong redirection in placement doc" 2017-11-21 12:23:07 +00:00
Takashi NATSUME e69f0f1d95 [placement] Fix a wrong redirection in placement doc
Change-Id: I9f404838c36618f5d632c6fb77b69287263f2611
2017-11-06 23:44:05 +00:00
Eric Fried ab5e2e00d2 placement: Contributor doc microversion checklist
I put out a new placement microversion [1] and initially missed updating
the API reference documentation [2].  I'd like to say it would have
helped if the checklist in the Microversion section of the contributor
doc had been up to date, except I didn't even know about that document
at the time.  Anyway, this change set adds that bullet - and I'll know
to refer to it next time.

[1] https://review.openstack.org/499826
[2] https://review.openstack.org/515748

Change-Id: Id0329d9824eeb1d210defe0567286372b72cb1cf
2017-10-31 15:07:57 -05:00
Stephen Finucane ef9cbc0017 doc: Populate the 'user' section
Per the spec [1]:

  user/ – end-user content such as concept guides, advice, tutorials,
  step-by-step instructions for using the CLI to perform specific tasks,
  etc.

The remaining content all ends up in here.

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

Change-Id: I480eee9cd7568efe2f76dd185004774588eb4a99
2017-07-18 15:41:20 +01: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