summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/configuration/protocols/index.rst2
-rw-r--r--docs/configuration/vpn/index.rst2
-rw-r--r--docs/index.rst22
-rw-r--r--docs/installation/cloud/index.rst2
-rw-r--r--docs/installation/install.rst2
-rw-r--r--docs/installation/virtual/index.rst2
6 files changed, 21 insertions, 11 deletions
diff --git a/docs/configuration/protocols/index.rst b/docs/configuration/protocols/index.rst
index c302d6a9..8568370d 100644
--- a/docs/configuration/protocols/index.rst
+++ b/docs/configuration/protocols/index.rst
@@ -1,3 +1,5 @@
+.. _protocols:
+
#########
Protocols
#########
diff --git a/docs/configuration/vpn/index.rst b/docs/configuration/vpn/index.rst
index abaca198..b90dc90a 100644
--- a/docs/configuration/vpn/index.rst
+++ b/docs/configuration/vpn/index.rst
@@ -1,3 +1,5 @@
+.. _vpn:
+
###
VPN
###
diff --git a/docs/index.rst b/docs/index.rst
index 603dcb73..0fc7ee80 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,22 +10,22 @@ VyOS User Guide
Get / Build VyOS
^^^^^^^^^^^^^^^^
- Quickly :ref:`Build<contributing/build-vyos:build vyos>` your own Image or take a look at how to :ref:`download<installation/install:download>` a free or supported version.
+ Quickly :ref:`Build<build>` your own Image or take a look at how to :ref:`download<download>` a free or supported version.
---
Install VyOS
^^^^^^^^^^^^
- Read about how to install VyOS on :ref:`Bare Metall<installation/install:installation>` or in a
- :ref:`Virtual Environment<installation/virtual/index:running vyos in virtual environments>` and
- how to use an image with the usual :ref:`cloud<installation/cloud/index:running VyOS in Cloud Environments>` providers
+ Read about how to install VyOS on :ref:`Bare Metall<installation>` or in a
+ :ref:`Virtual Environment<virtual_env>` and
+ how to use an image with the usual :ref:`cloud<cloud_env>` providers
---
Configuration and Operation
^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Use the :ref:`Quickstart Guide<quick-start:Quick Start>`, to have a fast overview. Or go deeper and
- set up :ref:`advanced routing<configuration/protocols/index:protocols>`,
- :ref:`VRFs<configuration/vrf/index:vrf>`, or
- :ref:`VPNs<configuration/vpn/index:vpn>` for example.
+ Use the :ref:`Quickstart Guide<quick-start>`, to have a fast overview. Or go deeper and
+ set up :ref:`advanced routing<protocols>`,
+ :ref:`VRFs<vrf>`, or
+ :ref:`VPNs<vpn>` for example.
---
Automate
@@ -37,16 +37,16 @@ VyOS User Guide
Examples
^^^^^^^^
- Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>`
+ Get some inspiration from the :ref:`Configuration Blueprints<examples>`
to build your infrastructure.
---
Contribute and Community
^^^^^^^^^^^^^^^^^^^^^^^^
| There are many ways to contribute to the project.
- | Add missing parts or improve the :ref:`Documentation<documentation:Write Documentation>`.
+ | Add missing parts or improve the :ref:`Documentation<documentation>`.
| Discuss in `Slack <https://slack.vyos.io/>`_ or the `Forum <https://forum.vyos.io>`_.
- | Or you can pick up a `Task <https://phabricator.vyos.net/>`_ and fix the :ref:`code<contributing/development:development>`.
+ | Or you can pick up a `Task <https://phabricator.vyos.net/>`_ and fix the :ref:`code<development>`.
.. toctree::
diff --git a/docs/installation/cloud/index.rst b/docs/installation/cloud/index.rst
index 5236f092..0df0de04 100644
--- a/docs/installation/cloud/index.rst
+++ b/docs/installation/cloud/index.rst
@@ -1,3 +1,5 @@
+.. _cloud_env:
+
##################################
Running VyOS in Cloud Environments
##################################
diff --git a/docs/installation/install.rst b/docs/installation/install.rst
index a4a91606..3fda6d53 100644
--- a/docs/installation/install.rst
+++ b/docs/installation/install.rst
@@ -48,6 +48,8 @@ The minimum system requirements are 512 MiB RAM and 2 GiB storage.
Depending on your use you might need additional RAM and CPU resources e.g.
when having multiple BGP full tables in your system.
+.. _download:
+
Download
========
diff --git a/docs/installation/virtual/index.rst b/docs/installation/virtual/index.rst
index 808439c7..45709a8e 100644
--- a/docs/installation/virtual/index.rst
+++ b/docs/installation/virtual/index.rst
@@ -1,3 +1,5 @@
+.. _virtual_env:
+
####################################
Running VyOS in Virtual Environments
####################################