summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-04-10 21:26:49 +0300
committerGitHub <noreply@github.com>2026-04-10 19:26:49 +0100
commitb5858598e32441560da34a4a62dc687fe4df9c16 (patch)
tree2233c7ea97b621cf5b68d60c0dd710c69ce9b45f /docs
parentd21db5fddd91e20e420b63928a8398745f571710 (diff)
downloadvyos-documentation-b5858598e32441560da34a4a62dc687fe4df9c16.tar.gz
vyos-documentation-b5858598e32441560da34a4a62dc687fe4df9c16.zip
docs: standardize RST heading hierarchy to # overline across 21 files (#1827)
Normalize top-level page headings from = or * underline-only to # overline+underline format, following RST/Sphinx best practices for consistent heading hierarchy. Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/automation/vyos-ansible.rst3
-rw-r--r--docs/automation/vyos-napalm.rst3
-rw-r--r--docs/automation/vyos-netmiko.rst3
-rw-r--r--docs/automation/vyos-pyvyos.rst3
-rw-r--r--docs/configexamples/azure-vpn-bgp.rst3
-rw-r--r--docs/configexamples/azure-vpn-dual-bgp.rst3
-rw-r--r--docs/configexamples/firewall.rst6
-rw-r--r--docs/configexamples/fwall-and-bridge.rst3
-rw-r--r--docs/configexamples/fwall-and-vrf.rst3
-rw-r--r--docs/configexamples/index.rst3
-rw-r--r--docs/configexamples/policy-based-ipsec-and-firewall.rst3
-rw-r--r--docs/configexamples/site-2-site-cisco.rst3
-rw-r--r--docs/configexamples/wan-load-balancing.rst3
-rw-r--r--docs/configexamples/zone-policy.rst3
-rw-r--r--docs/configuration/interfaces/tunnel.rst3
-rw-r--r--docs/configuration/service/mdns.rst3
-rw-r--r--docs/configuration/system/lcd.rst4
-rw-r--r--docs/installation/update.rst3
-rw-r--r--docs/installation/virtual/docker.rst4
-rw-r--r--docs/installation/virtual/libvirt.rst4
-rw-r--r--docs/installation/virtual/proxmox.rst4
21 files changed, 44 insertions, 26 deletions
diff --git a/docs/automation/vyos-ansible.rst b/docs/automation/vyos-ansible.rst
index 0ebcb924..993d1b21 100644
--- a/docs/automation/vyos-ansible.rst
+++ b/docs/automation/vyos-ansible.rst
@@ -2,8 +2,9 @@
.. _vyos-ansible:
+#######
Ansible
-=======
+#######
VyOS supports configuration via ansible.
Need to install ``ansible`` and ``python3-paramiko`` module
diff --git a/docs/automation/vyos-napalm.rst b/docs/automation/vyos-napalm.rst
index 75e20b3c..dc4d154f 100644
--- a/docs/automation/vyos-napalm.rst
+++ b/docs/automation/vyos-napalm.rst
@@ -2,8 +2,9 @@
.. _vyos-napalm:
+######
Napalm
-======
+######
VyOS supports some napalm_ functions for configuration and op-mode.
It requires more tests.
diff --git a/docs/automation/vyos-netmiko.rst b/docs/automation/vyos-netmiko.rst
index 075b0f34..53082e52 100644
--- a/docs/automation/vyos-netmiko.rst
+++ b/docs/automation/vyos-netmiko.rst
@@ -2,8 +2,9 @@
.. _vyos-netmiko:
+#######
Netmiko
-=======
+#######
VyOS supports configuration via netmiko_.
It requires to install ``python3-netmiko`` module.
diff --git a/docs/automation/vyos-pyvyos.rst b/docs/automation/vyos-pyvyos.rst
index 948534f8..c178aeb6 100644
--- a/docs/automation/vyos-pyvyos.rst
+++ b/docs/automation/vyos-pyvyos.rst
@@ -2,8 +2,9 @@
.. _vyos-pyvyos:
+######
pyvyos
-======
+######
pyvyos is a Python library designed for interacting with VyOS devices through
their API. This documentation is intended to guide you in using pyvyos for
diff --git a/docs/configexamples/azure-vpn-bgp.rst b/docs/configexamples/azure-vpn-bgp.rst
index 03d637d8..597a4d15 100644
--- a/docs/configexamples/azure-vpn-bgp.rst
+++ b/docs/configexamples/azure-vpn-bgp.rst
@@ -2,8 +2,9 @@
.. _examples-azure-vpn-bgp:
+############################################################
Route-Based Site-to-Site VPN to Azure (BGP over IKEv2/IPsec)
-------------------------------------------------------------
+############################################################
This guide shows an example of a route-based IKEv2 site-to-site VPN to
Azure using VTI and BGP for dynamic routing updates.
diff --git a/docs/configexamples/azure-vpn-dual-bgp.rst b/docs/configexamples/azure-vpn-dual-bgp.rst
index d37aa85c..04a6a631 100644
--- a/docs/configexamples/azure-vpn-dual-bgp.rst
+++ b/docs/configexamples/azure-vpn-dual-bgp.rst
@@ -2,8 +2,9 @@
.. _examples-azure-vpn-dual-bgp:
+######################################################################
Route-Based Redundant Site-to-Site VPN to Azure (BGP over IKEv2/IPsec)
-----------------------------------------------------------------------
+######################################################################
This guide shows an example of a redundant (active-active) route-based IKEv2
site-to-site VPN to Azure using VTI
diff --git a/docs/configexamples/firewall.rst b/docs/configexamples/firewall.rst
index a1ad7e19..6968eb04 100644
--- a/docs/configexamples/firewall.rst
+++ b/docs/configexamples/firewall.rst
@@ -1,9 +1,11 @@
:lastproofread: 2024-09-11
+#################
Firewall Examples
-=================
+#################
-This section contains examples of firewall configurations for various deployments.
+This section contains examples of firewall configurations for various
+deployments.
.. toctree::
:maxdepth: 2
diff --git a/docs/configexamples/fwall-and-bridge.rst b/docs/configexamples/fwall-and-bridge.rst
index 34744a5d..134dd6c0 100644
--- a/docs/configexamples/fwall-and-bridge.rst
+++ b/docs/configexamples/fwall-and-bridge.rst
@@ -1,7 +1,8 @@
:lastproofread: 2024-09-11
+###########################
Bridge and firewall example
----------------------------
+###########################
Scenario and requirements
^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/configexamples/fwall-and-vrf.rst b/docs/configexamples/fwall-and-vrf.rst
index 38663a18..992b625e 100644
--- a/docs/configexamples/fwall-and-vrf.rst
+++ b/docs/configexamples/fwall-and-vrf.rst
@@ -1,5 +1,6 @@
+########################
VRF and firewall example
-------------------------
+########################
Scenario and requirements
^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/configexamples/index.rst b/docs/configexamples/index.rst
index 7f173b4a..b5985d7f 100644
--- a/docs/configexamples/index.rst
+++ b/docs/configexamples/index.rst
@@ -1,7 +1,8 @@
.. _examples:
+########################
Configuration Blueprints
-========================
+########################
This chapter contains various configuration examples:
diff --git a/docs/configexamples/policy-based-ipsec-and-firewall.rst b/docs/configexamples/policy-based-ipsec-and-firewall.rst
index 60f8b888..5d98e944 100644
--- a/docs/configexamples/policy-based-ipsec-and-firewall.rst
+++ b/docs/configexamples/policy-based-ipsec-and-firewall.rst
@@ -1,8 +1,9 @@
.. _examples-policy-based-ipsec-and-firewall:
+########################################################
Policy-Based Site-to-Site VPN and Firewall Configuration
---------------------------------------------------------
+########################################################
This guide shows an example policy-based IKEv2 site-to-site VPN between two
VyOS routers, and firewall configuration.
diff --git a/docs/configexamples/site-2-site-cisco.rst b/docs/configexamples/site-2-site-cisco.rst
index 5b5f1fd7..e8322002 100644
--- a/docs/configexamples/site-2-site-cisco.rst
+++ b/docs/configexamples/site-2-site-cisco.rst
@@ -1,7 +1,8 @@
.. _examples-site-2-site-cisco:
+#############################################
Site-to-Site IPSec VPN to Cisco using FlexVPN
----------------------------------------------
+#############################################
This guide shows a sample configuration for FlexVPN site-to-site Internet
Protocol Security (IPsec)/Generic Routing Encapsulation (GRE) tunnel.
diff --git a/docs/configexamples/wan-load-balancing.rst b/docs/configexamples/wan-load-balancing.rst
index 0952cfe5..38490616 100644
--- a/docs/configexamples/wan-load-balancing.rst
+++ b/docs/configexamples/wan-load-balancing.rst
@@ -4,8 +4,9 @@
.. stop_vyoslinter # pictures and text have to change
+##########################
WAN Load Balancer examples
-==========================
+##########################
Example 1: Distributing load evenly
diff --git a/docs/configexamples/zone-policy.rst b/docs/configexamples/zone-policy.rst
index d0101ebf..0c1c2617 100644
--- a/docs/configexamples/zone-policy.rst
+++ b/docs/configexamples/zone-policy.rst
@@ -2,8 +2,9 @@
.. _examples-zone-policy:
+###################
Zone-Policy example
--------------------
+###################
.. note:: In :vytask:`T2199` the syntax of the zone configuration was changed.
The zone configuration moved from ``zone-policy zone <name>`` to ``firewall
diff --git a/docs/configuration/interfaces/tunnel.rst b/docs/configuration/interfaces/tunnel.rst
index 27c47a91..f1376cdf 100644
--- a/docs/configuration/interfaces/tunnel.rst
+++ b/docs/configuration/interfaces/tunnel.rst
@@ -2,8 +2,9 @@
.. _tunnel-interface:
+######
Tunnel
-======
+######
Tunnel interfaces are virtual links that transmit encapsulated traffic between
private networks or hosts across public infrastructure, such as the Internet.
diff --git a/docs/configuration/service/mdns.rst b/docs/configuration/service/mdns.rst
index b4ca1fd1..8a26722e 100644
--- a/docs/configuration/service/mdns.rst
+++ b/docs/configuration/service/mdns.rst
@@ -1,5 +1,6 @@
+#############
mDNS Repeater
--------------
+#############
Starting with VyOS 1.2 a :abbr:`mDNS (Multicast DNS)` repeater functionality is
provided. Additional information can be obtained from
diff --git a/docs/configuration/system/lcd.rst b/docs/configuration/system/lcd.rst
index 808d45a2..3fcf01dd 100644
--- a/docs/configuration/system/lcd.rst
+++ b/docs/configuration/system/lcd.rst
@@ -1,8 +1,8 @@
.. _system-display:
-********************
+####################
System Display (LCD)
-********************
+####################
The system LCD :abbr:`LCD (Liquid-crystal display)` option is for users running
VyOS on hardware that features an LCD display. This is typically a small display
diff --git a/docs/installation/update.rst b/docs/installation/update.rst
index 967f494b..81750dc1 100644
--- a/docs/installation/update.rst
+++ b/docs/installation/update.rst
@@ -2,8 +2,9 @@
.. _update_vyos:
+###########
Update VyOS
-===========
+###########
New system images can be added using the :opcmd:`add system image` command.
This command extracts the image and prompts you to use the current system
diff --git a/docs/installation/virtual/docker.rst b/docs/installation/virtual/docker.rst
index 282e4e63..d62c011b 100644
--- a/docs/installation/virtual/docker.rst
+++ b/docs/installation/virtual/docker.rst
@@ -2,9 +2,9 @@
.. _docker:
-******************************
+##############################
Run VyOS in a Docker Container
-******************************
+##############################
Docker is an open-source project for deploying applications as standardized
units called containers. Deploying VyOS in a container provides a simple and
diff --git a/docs/installation/virtual/libvirt.rst b/docs/installation/virtual/libvirt.rst
index 20b3ff1a..3aa665c0 100644
--- a/docs/installation/virtual/libvirt.rst
+++ b/docs/installation/virtual/libvirt.rst
@@ -2,9 +2,9 @@
.. _libvirt:
-****************************
+############################
Run VyOS on Libvirt QEMU/KVM
-****************************
+############################
Libvirt is an open-source API, daemon, and management tool for managing platform
virtualization. You can deploy VyOS on libvirt KVM in several ways:
diff --git a/docs/installation/virtual/proxmox.rst b/docs/installation/virtual/proxmox.rst
index 070627aa..6bd030e3 100644
--- a/docs/installation/virtual/proxmox.rst
+++ b/docs/installation/virtual/proxmox.rst
@@ -2,9 +2,9 @@
.. _proxmox:
-******************
+##################
Running on Proxmox
-******************
+##################
Proxmox is an open-source platform for virtualization. Visit
https://vyos.io to download a ``.qcow2`` image that you can import into