openstack/nova
Code Issues Proposed changes
nova/doc/source/contributor/index.rst
Akihiro Motoki 152d5c359c doc: Improve PDF document structure 
This is a follow-up patch for https://review.opendev.org/676730.

In the TOC of the current PDF file [1], most contents related to
user and admin guides are located under "For Contributors" section.
This is weird. It happens because the latex builder constructs
the document tree based on "toctree" directives even though they
are marked as "hidden".

This commit reorganizes "toctree" per section.
The "toctree" directives must be placed at the end of
individual sections. Otherwise, content of a last section and
content just after "toctree" directive are concatenated
into a same section in the rendered LaTeX document.

This commit also improves the following as well:

* Specify "openany" as "extraclassoptions" to skip blank pages
  along with "oneside" to use same page style for odd and even pages.
* Set "tocdepth" and "secnumdepth" to 3 respectively.
  "tocdepth" controls the depth of TOC and "secnumdepth" controls
  the level of numbered sections in TOC.

Note that this commit does not reorganize file structure under doc/source.
I believe this should be done separately.

[1] https://docs.openstack.org/nova/latest/doc-nova.pdf

Change-Id: Ie9685e6a4798357d4979aa6b4ff8a03663a9c71c
Story: 2006100
Task: 35140
2019-10-08 11:06:00 +01:00

5.1 KiB
Raw Blame History

Contributor Documentation

Contributing to nova gives you the power to help add features, fix bugs, enhance documentation, and increase testing. Contributions of any type are valuable, and part of what keeps the project going. Here are a list of resources to get your started.

Getting Started

  • /contributor/how-to-get-involved: Overview of engaging in the project
  • /contributor/development-environment: Get your computer setup to contribute

how-to-get-involved development-environment

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.

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-discuss mailing list, so we continue to improve how the nova community operates.

This section looks at the processes and why. The main aim behind all the process is to aid communication between all members of the nova community, while keeping users happy and keeping developers productive.

  • /contributor/project-scope: The focus is on features and bug fixes that make nova work better within this scope
  • /contributor/policies: General guidelines about what's supported
  • /contributor/process: The processes we follow around feature and bug submission, including how the release calendar works, and the freezes we go under
  • /contributor/blueprints: An overview of our tracking artifacts.
  • /contributor/ptl-guide: A chronological PTL reference guide

project-scope policies process blueprints ptl-guide

Reviewing

  • /contributor/releasenotes: When we need a release note for a contribution.
  • /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.
  • /reference/i18n: What we require for i18n in patches
  • /contributor/documentation: Guidelines for handling documentation contributions

releasenotes code-review /reference/i18n documentation

Testing

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.

  • /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.
    • /contributor/testing/libvirt-numa
    • /contributor/testing/serial-console
    • /contributor/testing/zero-downtime-upgrade
    • /contributor/testing/down-cell
  • Profiling Guides: These are guides to profiling nova.
    • /contributor/testing/eventlet-profiling

testing testing/libvirt-numa testing/serial-console testing/zero-downtime-upgrade testing/down-cell testing/eventlet-profiling

The Nova API

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.

  • /contributor/api: How the code is structured inside the API layer
  • /contributor/api-2: (needs update)
  • /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.
  • /contributor/api-ref-guideline: The guideline to write the API reference.

api api-2 microversions api-ref-guideline

Nova Major Subsystems

Major subsystems in nova have different needs. If you are contributing to one of these please read the reference guide <reference-internals> before diving in.

  • Move operations
    • /contributor/evacuate-vs-rebuild: Describes the differences between the often-confused evacuate and rebuild operations.

evacuate-vs-rebuild