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
Overview
Like everything else for the project, documentation-related tasks are tracked on the ONOS Project JIRA in the Documentation epic.
...
The ONOS documentation set contains the following major items:
- ONOS for Newcomers - Tutorials and Screencasts to get people new to ONOS up-to-speed
- Documentation Library - Main body of documentation for the platform in the form of User, Developer, and Architecture guides
- Use Cases - Landing page to each use case's documentation
- Feature Proposals - 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:
- Describing the design, architecture, and/or implementation, it is part of the Architecture Guide.
- How to extend or modify functionality through code (APIs, classes/interfaces, etc), it is part of the Developer's Guide.
- How a user can interact with it, it is part of the User's Guide.
Asking questions
Join us on the onos-docs channel on Slack, or send a message to the onos-discuss mailing list if you have any questions about how to contribute to documentation.
Procedure
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.
...
There may be several feedback cycles before the new pages are formally linked into the tutorials page or the documentation set.
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.
...