openstack/nova
Code Issues Proposed changes

doc: Address review comments for contributor index

Browse Source 
Per comments in If5e7940ddd0ae3316f7475742c02abfe3df28ac4.

Part of bp: doc-migration

Change-Id: Ide8921b0d891a65212bc2173e0113f4ce00f50b0
This commit is contained in:
Stephen Finucane 2017-08-07 16:11:57 +01:00 committed by Sean Dague
parent 7e693e9c5c
commit 3fcf82b32b
1 changed files with 25 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
doc/source/contributor/index.rst
View File

@ -20,9 +20,9 @@ Nova Process
The nova community is a large community. We have lots of users, and they all
have a lot of expectations around upgrade and backwards compatibility. For
example, having a good stable API, with discoverable versions and capabilities
is important for maintaining the strong ecosystem around Nova.
is important for maintaining the strong ecosystem around nova.
Our process is always evolving, just as nova and the community around Nova
Our process is always evolving, just as nova and the community around nova
evolves over time. If there are things that seem strange, or you have ideas on
how to improve things, please bring them forward on IRC or the openstack-dev
mailing list, so we continue to improve how the nova community operates.
@ -33,35 +33,42 @@ while keeping users happy and keeping developers productive.
* :doc:`/contributor/project-scope`: The focus is on features and bug fixes
that make nova work better within this scope
* :doc:`/contributor/policies`: General guidelines about what's supported
* :doc:`/contributor/process`: The processes we follow around feature and bug
submission, including how the release calendar works, and the freezes we go
under
* :doc:`/contributor/blueprints`: An overview of our tracking artifacts.
For Reviewers
=============
Reviewing
=========
* :doc:`/contributor/releasenotes`: When we need a release note for a
contribution.
* :doc:`/contributor/code-review`: important cheat sheet for what's important
* :doc:`/contributor/code-review`: Important cheat sheet for what's important
when doing code review in Nova, especially some things that are hard to test
for, but need human eyes.
* :doc:`/reference/i18n`: what we require for i18n in patches
* :doc:`/reference/i18n`: What we require for i18n in patches
* :doc:`/contributor/documentation`: Guidelines for handling documentation
contributions
Testing
=======
Because Python is a dynamic language, code that is not testing might not even
be python code. All new code needs to be validated somehow.
Because Python is a dynamic language, code that is not tested might not even
be Python code. All new code needs to be validated somehow.
* :doc:`/contributor/testing`: An overview of our test taxonomy, and the kinds
* :doc:`/contributor/testing`: An overview of our test taxonomy and the kinds
of testing we do and expect.
* **Testing Guides**: There are also specific testing guides for features that are
hard to test in our gate.
* **Testing Guides**: There are also specific testing guides for features that
are hard to test in our gate.
* :doc:`/contributor/testing/libvirt-numa`
@ -76,17 +83,20 @@ Because we have many consumers of our API, we're extremely careful about
changes done to the API, as the impact can be very wide.
* :doc:`/contributor/api`: How the code is structured inside the API layer
* :doc:`/contributor/api-2`: (needs update)
* :doc:`/contributor/microversions`: we use microversions to version our API,
this walks you through what you need to do when adding an API exposed feature
that needs one.
* :doc:`/contributor/microversions`: How the API is (micro)versioned and what
you need to do when adding an API exposed feature that needs a new
microversion.
Nova Major Subsystems
=====================
Major subsystems in Nova have different needs, some of those are documented
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.
* :doc:`/contributor/placement`
* :doc:`/user/conductor`