Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Welcome to the ONOS documentation pages! This page links to the most up-to date documentation for ONOS. 

Table of Contents
maxLevel3

Info
titleGetting Started
If you are new to ONOS, ONOS for Newcomers and the FAQs are great places to start.

The ONOS Guides

The ONOS guides provide comprehensive information, and are divided into several categories.  It To get the most out of the information, it is highly recommended that you work through the tutorials before taking a look at the ONOS guides.

...

We also provide Javadocs for the ONOS APIs.

Some Conventions

There are a few conventions that we use throughout these docs. Further conventions, if any, are described where relevant. 

  • Unix shell commands begin with '$' or for superuser, '#' :

    Code Block
    languagetext
    $ sudo -s
    # id
    uid=0(root) gid=0(root) groups=0(root)
  • ONOS CLI commands begin with 'onos>' :

    Code Block
    languagetext
    onos> summary
  • Both shell and CLI commands

...

  • are inlined in sentences in monospace font, e.g. ls or topology.
  • File names, directory paths, and keywords are in italic. 
  • User inputs and navigation of web pages are bold e.g. Ctrl-D and Browse > Pages. 

Further conventions, if any, are described where relevant. 

Acknowledgements

The contents of this wiki are contributed by various members of the ONOS Project.