diff options
| author | Christian Poessinger <christian@poessinger.com> | 2020-01-04 14:54:38 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-04 14:54:38 +0100 |
| commit | 8b52f2042487b0bac0be51509f2e1d23029041e3 (patch) | |
| tree | 7a34340a607c4de7c7a343b3da1109d43a7af005 /docs/contributing | |
| parent | 57913db57a4172988eb02c8d75062d36cdb6aa81 (diff) | |
| parent | 1d7328e3b701b12a4613c9dc91f4688220b577b2 (diff) | |
| download | vyos-documentation-8b52f2042487b0bac0be51509f2e1d23029041e3.tar.gz vyos-documentation-8b52f2042487b0bac0be51509f2e1d23029041e3.zip | |
Merge pull request #173 from rebortg/vyosextension
vyosextension
Diffstat (limited to 'docs/contributing')
| -rw-r--r-- | docs/contributing/documentation.rst | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index 2d9f14d1..8102e9a9 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -171,6 +171,12 @@ descriptive way in the resulting HTML/PDF manual. This will configure a static ARP entry always resolving `192.0.2.100` to `00:53:27:de:23:aa`. +For a inline configuration level command use ``:cfgcmd:`` + +.. code-block:: none + + :cfgcmd:`set interface ethernet eth0` + opcmd """"" @@ -186,10 +192,16 @@ descriptive way in the resulting HTML/PDF manual. Display all known ARP table entries spanning across all interfaces +For a inline operational level command use ``:opcmd:`` + +.. code-block:: none + + :opcmd:`add system image` + vytask """""" -When referencing to VyOS Phabricator Tasks, there is a custom Spinx Markup +When referencing to VyOS Phabricator Tasks, there is a custom Sphinx Markup command called ``vytask`` which automatically renders to a proper Phabricator URL. This is heavily used in the :ref:`release-notes` section. |