Appendix: create dedicated section in manual

2025-10-26 08:41:46 +01:00 · 2019-05-28 22:15:34 +02:00 · 2019-05-28 22:15:34 +02:00 · 337dcdf07c
commit 337dcdf07c
parent 6eac93d48a
10 changed files with 25 additions and 16 deletions
--- a/docs/appendix/commandtree/configmode.rst
+++ b/docs/appendix/commandtree/configmode.rst
--- a/docs/appendix/commandtree/index.rst
+++ b/docs/appendix/commandtree/index.rst
@ -1,7 +1,7 @@
 .. _commandtree:

-Appendix C - Command tree
-=========================
+Command tree
+============

 See the the full Command tree in Operational mode and Configuration mode

--- a/docs/appendix/commandtree/operationmode.rst
+++ b/docs/appendix/commandtree/operationmode.rst
--- a/docs/appendix/examples/dmvpn.rst
+++ b/docs/appendix/examples/dmvpn.rst
--- a/docs/appendix/examples/index.rst
+++ b/docs/appendix/examples/index.rst
@ -1,7 +1,7 @@
 .. _examples:

-Appendix B - Configuration Examples
-===================================
+Configuration Examples
+======================

 This chapter contains various configuration Examples

--- a/docs/appendix/examples/zone-policy.rst
+++ b/docs/appendix/examples/zone-policy.rst
--- a/docs/appendix/releasenotes.rst
+++ b/docs/appendix/releasenotes.rst
@ -1,7 +1,7 @@
 .. _releasenotes:

-Appendix E - Release notes
-##########################
+Release notes
+#############

 1.2 (Crux)
 ==========
--- a/docs/appendix/troubleshooting.rst
+++ b/docs/appendix/troubleshooting.rst
@ -1,7 +1,7 @@
 .. _troubleshooting:

-Appendix A - Troubleshooting
-============================
+Troubleshooting
+===============

 Sometimes things break or don't work as expected. This section describes
 several troubleshooting tools provided by VyOS that can help when something
--- a/docs/appendix/vyos-on-baremetal.rst
+++ b/docs/appendix/vyos-on-baremetal.rst
@ -1,7 +1,10 @@
 .. _vyosonbaremetal:

-Appendix D - Running on Bare Metal
-##################################
+Running on Bare Metal
+#####################
+
+Intel Atom C3000
+****************

 I opted to get one of the new Intel Atom C3000 CPUs to spawn VyOS on it.
 Running VyOS on an UEFI only device is supported as of VyOS release 1.2.
@ -66,4 +69,4 @@ Pictures

 .. figure:: /_static/images/1u_vyos_front_10ge_open_4.jpg
   :scale: 25 %
-   :alt: CSE-505-203B w/ 10GE Open 
+   :alt: CSE-505-203B w/ 10GE Open
--- a/docs/index.rst
+++ b/docs/index.rst
@ -31,11 +31,17 @@ as a router and firewall platform for cloud deployments.
    clustering.rst
    image-mgmt.rst
    commandscripting.rst
-    troubleshooting.rst
-    examples/index.rst
-    commandtree/index.rst
-    vyos-on-baremetal.rst
-    releasenotes.rst
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Appendix:
+    :includehidden:
+
+    appendix/releasenotes.rst
+    appendix/troubleshooting.rst
+    appendix/examples/index.rst
+    appendix/commandtree/index.rst
+    appendix/vyos-on-baremetal.rst

 .. toctree::
    :maxdepth: 2