From 7a570a03525b10dd7cf20dcc8e2f0af29fb443cd Mon Sep 17 00:00:00 2001 From: Robert Göhler Date: Tue, 18 Feb 2020 20:46:11 +0100 Subject: Build: fix document ref --- docs/appendix/cmd-index.rst | 7 ++++++- docs/cli.rst | 4 ++-- 2 files changed, 8 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/appendix/cmd-index.rst b/docs/appendix/cmd-index.rst index ad51a5ad..fa4143ad 100644 --- a/docs/appendix/cmd-index.rst +++ b/docs/appendix/cmd-index.rst @@ -1,16 +1,21 @@ -.. cmd-index: +.. _cmd-index: ################# Command Reference ################# + Operational Commands ==================== +.. _op_cmd_list: + .. opcmdlist:: Configuration Commands ====================== +.. _cfg_cmd_list: + .. cfgcmdlist:: diff --git a/docs/cli.rst b/docs/cli.rst index fb7506c8..51b8e874 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -5,11 +5,11 @@ CLI ### The VyOS :abbr:`CLI (Command-Line Interface)` comprises an -:ref:`commandtree_operationmode` and a :ref:`commandtree_configmode`. +operational and a configuration mode. Operational mode allows for commands to perform operational system tasks and view system and service status, while configuration mode allows for the -modification of system configuration. The :ref:`command tree page` +modification of system configuration. The :ref:`cmd-index` lists available commands and their functions. The CLI provides a built-in help system. In the CLI the ``?`` key may be used -- cgit v1.2.3 From 1537bffc5ce31c9487c5a1034f0785498a686019 Mon Sep 17 00:00:00 2001 From: Robert Göhler Date: Tue, 18 Feb 2020 20:48:17 +0100 Subject: Build PDF: convert unsupported SVG to PNG --- docs/_static/images/zone-policy-diagram.png | Bin 0 -> 113618 bytes docs/appendix/examples/zone-policy-diagram.svg | 3824 ------------------------ docs/appendix/examples/zone-policy.rst | 2 +- 3 files changed, 1 insertion(+), 3825 deletions(-) create mode 100644 docs/_static/images/zone-policy-diagram.png delete mode 100644 docs/appendix/examples/zone-policy-diagram.svg (limited to 'docs') diff --git a/docs/_static/images/zone-policy-diagram.png b/docs/_static/images/zone-policy-diagram.png new file mode 100644 index 00000000..cfde4af6 Binary files /dev/null and b/docs/_static/images/zone-policy-diagram.png differ diff --git a/docs/appendix/examples/zone-policy-diagram.svg b/docs/appendix/examples/zone-policy-diagram.svg deleted file mode 100644 index 7fb14ecd..00000000 --- a/docs/appendix/examples/zone-policy-diagram.svg +++ /dev/null @@ -1,3824 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - VyOS - - DMZ - 192.168.200.0/24 - 2001:0DB8:0:BBBB::0/64 - - LAN - 192.168.100.0/24 - 2001:0DB8:0:AAAA::0/64 - - WAN - 172.16.10.0/24 - 2001:0DB8:0:9999::0/64 - Logical - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Managed Switch - ISP Modem - VyOS - LAN Hosts - DMZ Hosts - - VLAN 10 - - VLAN 20 - - VLAN 30 - - Trunk - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Physical - - diff --git a/docs/appendix/examples/zone-policy.rst b/docs/appendix/examples/zone-policy.rst index f655b4fe..90ece39a 100644 --- a/docs/appendix/examples/zone-policy.rst +++ b/docs/appendix/examples/zone-policy.rst @@ -18,7 +18,7 @@ We have three networks. This specific example is for a router on a stick, but is very easily adapted for however many NICs you have. -.. image:: zone-policy-diagram.svg +.. image:: /_static/images/zone-policy-diagram.png :width: 80% :align: center :alt: Network Topology Diagram -- cgit v1.2.3