summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-05-28 22:15:34 +0200
committerChristian Poessinger <christian@poessinger.com>2019-05-28 22:15:34 +0200
commit337dcdf07c51df2208da65aa9c5ab06a09d5cc3a (patch)
tree120fe7182b563c092331a7a67af3cfd7aab97cb2 /docs
parent6eac93d48aed2280dc5fe20a57cba491e7a3ea10 (diff)
downloadvyos-documentation-337dcdf07c51df2208da65aa9c5ab06a09d5cc3a.tar.gz
vyos-documentation-337dcdf07c51df2208da65aa9c5ab06a09d5cc3a.zip
Appendix: create dedicated section in manual
Diffstat (limited to 'docs')
-rw-r--r--docs/appendix/commandtree/configmode.rst (renamed from docs/commandtree/configmode.rst)0
-rw-r--r--docs/appendix/commandtree/index.rst (renamed from docs/commandtree/index.rst)4
-rw-r--r--docs/appendix/commandtree/operationmode.rst (renamed from docs/commandtree/operationmode.rst)0
-rw-r--r--docs/appendix/examples/dmvpn.rst (renamed from docs/examples/dmvpn.rst)0
-rw-r--r--docs/appendix/examples/index.rst (renamed from docs/examples/index.rst)4
-rw-r--r--docs/appendix/examples/zone-policy.rst (renamed from docs/examples/zone-policy.rst)0
-rw-r--r--docs/appendix/releasenotes.rst (renamed from docs/releasenotes.rst)4
-rw-r--r--docs/appendix/troubleshooting.rst (renamed from docs/troubleshooting.rst)4
-rw-r--r--docs/appendix/vyos-on-baremetal.rst (renamed from docs/vyos-on-baremetal.rst)9
-rw-r--r--docs/index.rst16
10 files changed, 25 insertions, 16 deletions
diff --git a/docs/commandtree/configmode.rst b/docs/appendix/commandtree/configmode.rst
index abb20f98..abb20f98 100644
--- a/docs/commandtree/configmode.rst
+++ b/docs/appendix/commandtree/configmode.rst
diff --git a/docs/commandtree/index.rst b/docs/appendix/commandtree/index.rst
index 040e6f03..c3bca008 100644
--- a/docs/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
diff --git a/docs/commandtree/operationmode.rst b/docs/appendix/commandtree/operationmode.rst
index 487df032..487df032 100644
--- a/docs/commandtree/operationmode.rst
+++ b/docs/appendix/commandtree/operationmode.rst
diff --git a/docs/examples/dmvpn.rst b/docs/appendix/examples/dmvpn.rst
index d3bf45c7..d3bf45c7 100644
--- a/docs/examples/dmvpn.rst
+++ b/docs/appendix/examples/dmvpn.rst
diff --git a/docs/examples/index.rst b/docs/appendix/examples/index.rst
index e976affd..c6e10eeb 100644
--- a/docs/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
diff --git a/docs/examples/zone-policy.rst b/docs/appendix/examples/zone-policy.rst
index d159d02d..d159d02d 100644
--- a/docs/examples/zone-policy.rst
+++ b/docs/appendix/examples/zone-policy.rst
diff --git a/docs/releasenotes.rst b/docs/appendix/releasenotes.rst
index 7adc5839..a2d9616e 100644
--- a/docs/releasenotes.rst
+++ b/docs/appendix/releasenotes.rst
@@ -1,7 +1,7 @@
.. _releasenotes:
-Appendix E - Release notes
-##########################
+Release notes
+#############
1.2 (Crux)
==========
diff --git a/docs/troubleshooting.rst b/docs/appendix/troubleshooting.rst
index 80a46932..e5b9b7a9 100644
--- a/docs/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
diff --git a/docs/vyos-on-baremetal.rst b/docs/appendix/vyos-on-baremetal.rst
index 0c2868e7..bda81116 100644
--- a/docs/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
diff --git a/docs/index.rst b/docs/index.rst
index c4932c88..e9b1e262 100644
--- 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