summaryrefslogtreecommitdiff
path: root/docs/configexamples
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/configexamples
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/configexamples')
-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
10 files changed, 22 insertions, 11 deletions
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