Page tree

Have questions? Stuck? Please check our FAQ for some common questions and answers.

This wiki documents the current development version of ONOS (master). Refer to the Wiki Archives for documentation for all previous versions of ONOS.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 23 Current »

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

Contents

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

Conventions used

There are a few conventions that we use throughout these docs.

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

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

    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. 
  • Italic and monospace terms may also be bolded to emphasize them.

Further conventions, if any, are described where relevant. 

Contributing

We try our best to keep this wiki and documentation set up-to-date. Please refer to Contributing to ONOS Documentation if you're interested in helping out.

  • No labels