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.
...
- ONOS for Newcomers - Tutorials and Screencasts to get people new to ONOS up-to-speed
- Documentation Library Guides - 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
...
- 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:
- The design, architecture, and/or implementation, it is part of the Architecture and Internals 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 Administrator Guide.
- 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.
...
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. For a sample template page implementing the conventions described here, refer to Sample Document Template. |
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:
...