Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In addition to the tutorials, the ONOS documentation setDocumentation Set provides guides describing various aspects of using and developing on ONOS, as well as its architecture and API documentation (Javadocs). For developers, the recommended way to use the documentation set is:

  1. Learn how to install, run, and use ONOS, as per the User's Guide
  2. Learn how to set up the development/test environment and the usage of JIRA and Gerrit, and testing and coding guidelines as per the Developer's Guide
  3. Reference relevant parts of the Architecture Guide, Javadocs, and Developer's Guide Appendices

Readers interested in contributing to the documentation effort should focus on Contributing to ONOS Documentation as step 2. of the above.

Project Model

Contributors begin as submitters, and may progress to committer status. In a similar vein, contributors may work on the existing ONOS codebase and use cases, or, with approval of the technical steering group, introduce their own work as a sanctioned project. ONOS Governance describes the project model that the ONOS Project follows in further detail.

...