This section describes how to contribute documentation to the project. It also describes the formatting conventions that are used by the pages in the ONOS documentation set.
The ONOS documentation set contains the following major items:
- Guides - Main body of documentation for the platform in the form of the Administrator, Developer, Architecture, Contributor, and System Testing guides
- Use Cases - Landing page to each use case's documentation
- Projects - Landing page to each in-progress or experimental feature in various stages of development
There are more sections, but the above set are the sections that a contributors are usually interested in. Except for the use cases, which are maintained by the members of the use cases, most everything else is contributed by the general ONOS community.
Where should <TOPIC> go?
Often, someone has something that they would like to write about, but isn't sure about where to add their topic(s). The following rules can be followed to get an idea about where to place a certain item:
- If it describes steps for how to build up to a specific, tangible example that can be run, it is a tutorial.
- If it describes a work-in-progress or a to-be-implemented function related to ONOS itself, it is a feature proposal.
- If it describes a mature function or feature and focuses on:
- If it describes anything about a use case, it should be added under Use Cases. For existing use cases, it is best to consult its members for where the page/topic belongs.
Documentation section owners
Similar to the Module Owners for the ONOS code base, parts of the documentation set may have owners associated with them. The section owners are responsible for maintaining the organization and content of the sections that they own, and may be contacted with questions about the pages or the type of content that they maintain.
A contributor may become a section owner by creating a set of pages, working on something associated with a certain section of the docs, or volunteering as an owner of certain content on the mailing list or documentation Slack channel. The current list of section owners are listed in the Documentation Section Owners page.
Have questions or want to talk with us about docs? Join us on one of these channels:
Please join us for our regular community documentation calls. Details below:
- Time: Every other Wednesday at 1 pacific (check the ONOS Community Calendar for dates)
- Dial-in: https://www.uberconference.com/davidwboswell
- Agenda and Meeting notes: ONOS Documentation
Like everything else for the project, prominent documentation-related tasks are tracked on the ONOS Project JIRA in the Documentation epic. Anyone interested in contributing should register for an account for the project Wiki and JIRA. To register, go here and follow the 'Join ONOS' button.
Working on existing tasks
A potential contributor should take ownership of a ticket if they see a task that they're interested in. A current maintainer (or, if the item is related to an owned part of the docs, likely the section owner) will review the changes, and provide feedback if needed. Find a list of documentation tasks that need someone to drive on Jira (and once one of these documentation tasks is done, we're happy to thank you with some ONOS swag).
Adding new content
A contributor interested in adding new content (tutorials, sections in the guides, etc.) should check if a JIRA ticket exists for the task in mind. If not, they should create a new ticket for the task, and take ownership of it. Messages should be sent to onos-discuss:
- If the content is associated with a section with a section owner
- Initially with ideas for the content (to help de-duplicate effort)
- With link(s) to the new content once it's written (so that reviewers are aware of the content)
There may be several feedback cycles before the new pages are formally linked into the documentation set. It is generally a good idea to follow the Wiki Formatting Conventions while adding new content