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.
...
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.
Procedure
Tickets for documentation-related tasks belong in the Documentation epic in the project JIRA.
Working on existing tasks
A potential contributor should message onos-discuss if they are interested in contributing tutorials and full sections in the guides, or maintaining sections in the documentations.
...
take ownership of a ticket if they see a task that they're interested in. A current maintainer will review the changes, and provide feedback if needed.
...
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.
A message should be sent to onos-discuss:
- With ideas for the content (this helps de-duplicate effort)
- Link(s) to the new content (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. |
Finding Tasks
...
| . |
Formatting Conventions
Several conventions are used within the documents, and any new material should conform to them to keep a uniform look.
...