Documentation guide

This information explains how to contribute to the OpenSwitch OPX Base documentation. OPX Base uses the open-source GitHub Markup library so you can write in Markdown, RST, Textile, or any other supported format.

Preferences

• Don't use h1 — use h2 (## This is a title) for easy reading
• Use h3 for step headers — aids readability (see example below)
• Sentence-case titles only — aids readability and simplifies organization
• Only one space after each sentence — no need to use two spaces
• All paths should be in italics — use underscore before and after the path
• Don't leave single sentences hanging — combine with relevant information for readability
• All code examples should be indented four spaces in Code view — automatically adds grey box around code (see example below)
• Step numbers should appear in bold (1) — helps step numbers stand out
• All code should be tagged as Code ($ sudo) — aids readability and helps developers quickly identify code

Example

OPX Base repository

1. Configure /etc/apt/sources.list to point to the external OPX Base package repository.

deb http://dl.bintray.com/open-switch/opx-apt jessie main
deb https://dell-networking.bintray.com/opx-apt jessie main

2. Update and install the package.

sudo apt-get update
sudo apt-get install opx-dell-s6000
reboot

Capitalization

• ACL — not Acl or acl
• API — not api
• Linux — not linux or LINUX
• NETCONF — not Netconf or netconf
• QoS — not qos, Qos or QOS
• URL — not url or Url
• YANG — not Yang or yang

Notes

All notes or important information should be tagged as Blockquote (>) to stand out and be easily noticed.

NOTE: This is important information.