diff options
Diffstat (limited to 'docs/documentation.rst')
| -rw-r--r-- | docs/documentation.rst | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/docs/documentation.rst b/docs/documentation.rst index 77cd5cc4..1d7e3402 100644 --- a/docs/documentation.rst +++ b/docs/documentation.rst @@ -196,7 +196,7 @@ to use an alternative hyperlink use it this way: handle build errors """"""""""""""""""" -The plugin will warn on build if a headline has a duplicate name in the +The plugin will warn on build if a headline has a duplicate name in the same document. To prevent this warning, you have to put a custom link on top of the headline. @@ -216,7 +216,7 @@ top of the headline. ========== Lorem ipsum dolor sit amet, consetetur sadipscing elitr - + .. _section B example: Example @@ -295,6 +295,21 @@ For an inline configuration level command, use ``:cfgcmd:`` :cfgcmd:`set interface ethernet eth0` + +To extract a defaultvalue from the XML definitions add a ``:defaultvalue:`` +to ``.. cfgcmd::`` directive. +To have this feature locally, the vyos-1x submodule must be initialized before. +Please be aware to not update the submodule in your PR. + +.. code-block:: none + + .. cfgcmd:: set system conntrack table-size <1-50000000> + :defaultvalue: + + The connection tracking table contains one entry for each connection being + tracked by the system. + + opcmd """"" @@ -377,7 +392,7 @@ All RST files must follow the same TOC Level syntax and have to start with .. code-block:: ##### - Titel + Title ##### Configuration mode pages @@ -389,7 +404,7 @@ stability for URLs used in the forum or blogpost. For example: - * ``set zone-policy`` is written in ``zone-policy/index.rst`` + * ``set firewall zone`` is written in ``firewall/zone.rst`` * ``set interfaces ethernet`` is written in ``interfaces/ethernet.rst`` The article starts with a short introduction about the command or the |