Versions Compared

Key

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

...

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 as much as possible, relying on formatting and macros provided by the Confluence interface. 

Procedure

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.

...

  • For Individual Pages :
    A new page should always have a table of contents near the top, after a brief summary of the page. The Table of Contents macro is used to automatically grow the TOC out of the page as sections are added. To add a TOC, select Insert > Table of Contents. A popup for TOC options should appear. Here, set the Maximum Heading Level to 3, to prevent the TOC from capturing subsections past Heading 3. This aids to reduce the noise in the listing. 

  • For the Guides
    An ONOS guidebook is a collection of child pages under one parent page containing whose parent pages contain a top-level table of contents. This TOC shows pages and their main sections (i.e. up to Heading 2 of a page) as links.

...