From b1cb71c71935ad6b0a7d9effe8f4dc4467de2175 Mon Sep 17 00:00:00 2001 From: rebortg Date: Mon, 30 Nov 2020 21:15:16 +0100 Subject: [PATCH] arrange: system configration --- docs/automation/index.rst | 3 +- docs/configuration/system/acceleration.rst | 7 ++++ .../system/config-management.rst | 2 ++ docs/configuration/system/conntrack.rst | 2 ++ .../system/console.rst} | 0 .../system/default-route.rst | 0 docs/configuration/system/domain-name.rst | 2 ++ docs/configuration/system/domain-search.rst | 2 ++ .../system/eventhandler.rst | 0 .../system/flow-accounting.rst | 0 .../system/host-name.rst} | 0 docs/configuration/system/index.rst | 32 +++++++++++++++++++ docs/configuration/system/ip.rst | 2 ++ docs/configuration/system/ipv6.rst | 2 ++ docs/{ => configuration}/system/lcd.rst | 0 .../system/login.rst} | 0 .../system/name-server.rst} | 0 .../system/name-servers-dhcp.rst | 2 ++ docs/{ => configuration}/system/ntp.rst | 0 docs/{ => configuration}/system/option.rst | 0 docs/{ => configuration}/system/proxy.rst | 0 .../system/static-host-mapping.rst | 2 ++ docs/configuration/system/sysctl.rst | 2 ++ docs/{ => configuration}/system/syslog.rst | 0 .../system/task-scheduler.rst | 0 docs/{ => configuration}/system/time-zone.rst | 0 .../system/wifi-requlatory-domain.rst | 2 ++ docs/index.rst | 8 +++-- docs/{system => operation}/boot-options.rst | 0 docs/{ => operation}/information.rst | 0 docs/system/advanced-index.rst | 19 ----------- docs/system/basic-index.rst | 14 -------- 32 files changed, 65 insertions(+), 38 deletions(-) create mode 100644 docs/configuration/system/acceleration.rst create mode 100644 docs/configuration/system/config-management.rst create mode 100644 docs/configuration/system/conntrack.rst rename docs/{system/serial-console.rst => configuration/system/console.rst} (100%) rename docs/{ => configuration}/system/default-route.rst (100%) create mode 100644 docs/configuration/system/domain-name.rst create mode 100644 docs/configuration/system/domain-search.rst rename docs/{ => configuration}/system/eventhandler.rst (100%) rename docs/{ => configuration}/system/flow-accounting.rst (100%) rename docs/{system/host-information.rst => configuration/system/host-name.rst} (100%) create mode 100644 docs/configuration/system/index.rst create mode 100644 docs/configuration/system/ip.rst create mode 100644 docs/configuration/system/ipv6.rst rename docs/{ => configuration}/system/lcd.rst (100%) rename docs/{system/user-management.rst => configuration/system/login.rst} (100%) rename docs/{system/system-dns.rst => configuration/system/name-server.rst} (100%) create mode 100644 docs/configuration/system/name-servers-dhcp.rst rename docs/{ => configuration}/system/ntp.rst (100%) rename docs/{ => configuration}/system/option.rst (100%) rename docs/{ => configuration}/system/proxy.rst (100%) create mode 100644 docs/configuration/system/static-host-mapping.rst create mode 100644 docs/configuration/system/sysctl.rst rename docs/{ => configuration}/system/syslog.rst (100%) rename docs/{ => configuration}/system/task-scheduler.rst (100%) rename docs/{ => configuration}/system/time-zone.rst (100%) create mode 100644 docs/configuration/system/wifi-requlatory-domain.rst rename docs/{system => operation}/boot-options.rst (100%) rename docs/{ => operation}/information.rst (100%) delete mode 100644 docs/system/advanced-index.rst delete mode 100644 docs/system/basic-index.rst diff --git a/docs/automation/index.rst b/docs/automation/index.rst index 1f2b40b1..e07dfecc 100644 --- a/docs/automation/index.rst +++ b/docs/automation/index.rst @@ -12,5 +12,4 @@ VyOS Automation .. toctree:: :maxdepth: 1 - command-scripting - http-api \ No newline at end of file + command-scripting \ No newline at end of file diff --git a/docs/configuration/system/acceleration.rst b/docs/configuration/system/acceleration.rst new file mode 100644 index 00000000..b09da38b --- /dev/null +++ b/docs/configuration/system/acceleration.rst @@ -0,0 +1,7 @@ +.. _acceleration: + +############ +Acceleration +############ + + diff --git a/docs/configuration/system/config-management.rst b/docs/configuration/system/config-management.rst new file mode 100644 index 00000000..40973713 --- /dev/null +++ b/docs/configuration/system/config-management.rst @@ -0,0 +1,2 @@ +config-management +################# \ No newline at end of file diff --git a/docs/configuration/system/conntrack.rst b/docs/configuration/system/conntrack.rst new file mode 100644 index 00000000..7d5d4308 --- /dev/null +++ b/docs/configuration/system/conntrack.rst @@ -0,0 +1,2 @@ +conntrack +######### \ No newline at end of file diff --git a/docs/system/serial-console.rst b/docs/configuration/system/console.rst similarity index 100% rename from docs/system/serial-console.rst rename to docs/configuration/system/console.rst diff --git a/docs/system/default-route.rst b/docs/configuration/system/default-route.rst similarity index 100% rename from docs/system/default-route.rst rename to docs/configuration/system/default-route.rst diff --git a/docs/configuration/system/domain-name.rst b/docs/configuration/system/domain-name.rst new file mode 100644 index 00000000..9028b65b --- /dev/null +++ b/docs/configuration/system/domain-name.rst @@ -0,0 +1,2 @@ +domain-name +########### \ No newline at end of file diff --git a/docs/configuration/system/domain-search.rst b/docs/configuration/system/domain-search.rst new file mode 100644 index 00000000..f4aef62e --- /dev/null +++ b/docs/configuration/system/domain-search.rst @@ -0,0 +1,2 @@ +domain-search +############# \ No newline at end of file diff --git a/docs/system/eventhandler.rst b/docs/configuration/system/eventhandler.rst similarity index 100% rename from docs/system/eventhandler.rst rename to docs/configuration/system/eventhandler.rst diff --git a/docs/system/flow-accounting.rst b/docs/configuration/system/flow-accounting.rst similarity index 100% rename from docs/system/flow-accounting.rst rename to docs/configuration/system/flow-accounting.rst diff --git a/docs/system/host-information.rst b/docs/configuration/system/host-name.rst similarity index 100% rename from docs/system/host-information.rst rename to docs/configuration/system/host-name.rst diff --git a/docs/configuration/system/index.rst b/docs/configuration/system/index.rst new file mode 100644 index 00000000..ecf09a64 --- /dev/null +++ b/docs/configuration/system/index.rst @@ -0,0 +1,32 @@ +###### +System +###### + + +.. toctree:: + :maxdepth: 1 + :includehidden: + + acceleration + config-management + conntrack + console + domain-name + domain-search + flow-accounting + host-name + ip + ipv6 + lcd + login + name-server + name-servers-dhcp + ntp + options + proxy + static-host-mapping + sysctl + syslog + task-scheduler + time-zone + wifi-requlatory-domain diff --git a/docs/configuration/system/ip.rst b/docs/configuration/system/ip.rst new file mode 100644 index 00000000..74116eb0 --- /dev/null +++ b/docs/configuration/system/ip.rst @@ -0,0 +1,2 @@ +ip +## \ No newline at end of file diff --git a/docs/configuration/system/ipv6.rst b/docs/configuration/system/ipv6.rst new file mode 100644 index 00000000..19ed6d62 --- /dev/null +++ b/docs/configuration/system/ipv6.rst @@ -0,0 +1,2 @@ +ipv6 +#### \ No newline at end of file diff --git a/docs/system/lcd.rst b/docs/configuration/system/lcd.rst similarity index 100% rename from docs/system/lcd.rst rename to docs/configuration/system/lcd.rst diff --git a/docs/system/user-management.rst b/docs/configuration/system/login.rst similarity index 100% rename from docs/system/user-management.rst rename to docs/configuration/system/login.rst diff --git a/docs/system/system-dns.rst b/docs/configuration/system/name-server.rst similarity index 100% rename from docs/system/system-dns.rst rename to docs/configuration/system/name-server.rst diff --git a/docs/configuration/system/name-servers-dhcp.rst b/docs/configuration/system/name-servers-dhcp.rst new file mode 100644 index 00000000..6719fef9 --- /dev/null +++ b/docs/configuration/system/name-servers-dhcp.rst @@ -0,0 +1,2 @@ +name-servers-dhcp +################# \ No newline at end of file diff --git a/docs/system/ntp.rst b/docs/configuration/system/ntp.rst similarity index 100% rename from docs/system/ntp.rst rename to docs/configuration/system/ntp.rst diff --git a/docs/system/option.rst b/docs/configuration/system/option.rst similarity index 100% rename from docs/system/option.rst rename to docs/configuration/system/option.rst diff --git a/docs/system/proxy.rst b/docs/configuration/system/proxy.rst similarity index 100% rename from docs/system/proxy.rst rename to docs/configuration/system/proxy.rst diff --git a/docs/configuration/system/static-host-mapping.rst b/docs/configuration/system/static-host-mapping.rst new file mode 100644 index 00000000..97d9a443 --- /dev/null +++ b/docs/configuration/system/static-host-mapping.rst @@ -0,0 +1,2 @@ +static-host-mapping +################### \ No newline at end of file diff --git a/docs/configuration/system/sysctl.rst b/docs/configuration/system/sysctl.rst new file mode 100644 index 00000000..82ffd159 --- /dev/null +++ b/docs/configuration/system/sysctl.rst @@ -0,0 +1,2 @@ +sysctl +###### \ No newline at end of file diff --git a/docs/system/syslog.rst b/docs/configuration/system/syslog.rst similarity index 100% rename from docs/system/syslog.rst rename to docs/configuration/system/syslog.rst diff --git a/docs/system/task-scheduler.rst b/docs/configuration/system/task-scheduler.rst similarity index 100% rename from docs/system/task-scheduler.rst rename to docs/configuration/system/task-scheduler.rst diff --git a/docs/system/time-zone.rst b/docs/configuration/system/time-zone.rst similarity index 100% rename from docs/system/time-zone.rst rename to docs/configuration/system/time-zone.rst diff --git a/docs/configuration/system/wifi-requlatory-domain.rst b/docs/configuration/system/wifi-requlatory-domain.rst new file mode 100644 index 00000000..2b6ce7d4 --- /dev/null +++ b/docs/configuration/system/wifi-requlatory-domain.rst @@ -0,0 +1,2 @@ +wifi-requlatory-domain +###################### \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 4612d5f8..96272fff 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,16 +4,17 @@ VyOS User Guide ############### - .. toctree:: :maxdepth: 2 :hidden: + :caption: FIND CAPTION NAME introducing/about introducing/history introducing/releases changelog/index + .. toctree:: :maxdepth: 2 :hidden: @@ -21,9 +22,8 @@ VyOS User Guide :caption: first steps installation/index - quick-start + quickstart/index cli - .. toctree:: :maxdepth: 2 @@ -31,6 +31,7 @@ VyOS User Guide :includehidden: :caption: Adminguide + configuration/index operation/index automation/index @@ -44,5 +45,6 @@ VyOS User Guide :includehidden: :caption: Contributing + contributing/index copyright diff --git a/docs/system/boot-options.rst b/docs/operation/boot-options.rst similarity index 100% rename from docs/system/boot-options.rst rename to docs/operation/boot-options.rst diff --git a/docs/information.rst b/docs/operation/information.rst similarity index 100% rename from docs/information.rst rename to docs/operation/information.rst diff --git a/docs/system/advanced-index.rst b/docs/system/advanced-index.rst deleted file mode 100644 index 8e855789..00000000 --- a/docs/system/advanced-index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _advanced_system_tweaks: - -###### -System -###### - -.. toctree:: - :maxdepth: 2 - - boot-options - eventhandler - flow-accounting - lcd - ntp - option - proxy - serial-console - syslog - task-scheduler diff --git a/docs/system/basic-index.rst b/docs/system/basic-index.rst deleted file mode 100644 index b7bbf1c5..00000000 --- a/docs/system/basic-index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _basic_system_tweaks: - -################### -Basic System Tweaks -################### - -.. toctree:: - :maxdepth: 2 - - user-management - host-information - default-route - time-zone - system-dns