Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
...
Table of Contents maxLevel 3
Contributing to ONOS Documentation
The ONOS Guides and tutorials are written using the Confluence Wiki markup interface. In order to lower the curve required to add or edit information, and to introduce consistency, the Guides avoid the usage of raw HTML and Wiki Notation (the exceptions being some of the Appendix pages), instead relying on formatting and macros provided by the default Confluence interface.
Overview
Like everything else for the project, documentation-related tasks are tracked on the ONOS Project JIRA in the Documentation epicTickets for documentation-related tasks belong in the Documentation epic in the project JIRA.
Procedure
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.
...
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.A message Messages should be sent to onos-discuss:
- With Initially with ideas for the content (this helps to help de-duplicate effort)
- LinkWith 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 tutorials page or the documentation set.
| Info |
|---|
| For an introduction to the basics of editing the wiki, refer to Getting Started with Wiki Contents. |
...
Formatting Conventions
The ONOS Guides and tutorials are written using the Confluence Wiki markup interface. In order to lower the curve required to add or edit information, and to introduce consistency, the Guides avoid the usage of raw HTML and Wiki Notation (the exceptions being some of the Appendix pages), instead relying on formatting and macros provided by the default Confluence interface.
Several conventions are used within the documents, and any new material should conform to them to keep a uniform look.
| Info |
|---|
| For an introduction to the basics of editing the wiki, refer to Getting Started with Wiki Contents. |
Section Headings
Each section in a page should have a terse title in one of the Heading levels under the Paragraph dropdown. The convention for (sub)section headings are:
...