summaryrefslogtreecommitdiff
path: root/docs/index.md
diff options
context:
space:
mode:
authorLiudmylaNad <l.nadolina@vyos.io>2026-08-04 11:54:54 +0200
committerGitHub <noreply@github.com>2026-08-04 10:54:54 +0100
commit873a388fdb5faeb869881cc780de16c96385e433 (patch)
treea45874674c10ef5611e39b040ecc01ec48f8911b /docs/index.md
parent2ea0928fc0277eacb208765ab119055908b8e184 (diff)
downloadvyos-documentation-sagitta.tar.gz
vyos-documentation-sagitta.zip
docs: fix MyST roles used inside eval-rst blocks (#2125)sagitta
* docs: fix MyST roles used inside eval-rst blocks * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md40
1 files changed, 26 insertions, 14 deletions
diff --git a/docs/index.md b/docs/index.md
index 499a4926..65858eea 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -9,43 +9,55 @@
.. grid-item-card:: 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 <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.
.. grid-item-card:: Install VyOS
- Read about how to install VyOS on {ref}`Bare Metal<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 Metal <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
.. grid-item-card:: 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: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.
.. grid-item-card:: Automate
Integrate VyOS in your automation Workflow with
- {ref}`Ansible<vyos-ansible>`,
- have your own {ref}`local scripts<command-scripting>`, or configure VyOS with the {ref}`HTTPS-API<vyosapi>`.
+ :ref:`Ansible <vyos-ansible>`,
+ have your own :ref:`local scripts <command-scripting>`, or configure
+ VyOS with the :ref:`HTTPS-API <vyosapi>`.
.. grid-item-card:: Examples
- Get some inspiration from the {ref}`Configuration Blueprints<configexamples/index:Configuration Blueprints>`
+ Get some inspiration from the
+ :ref:`configexamples/index:Configuration Blueprints`
to build your infrastructure.
.. grid-item-card:: Contribute and Community
| There are many ways to contribute to the project.
- | Add missing parts or improve the {ref}`Documentation<documentation:Write Documentation>`.
- | Discuss in `Slack <https://slack.vyos.io/>`_ or the `Forum <https://forum.vyos.io>`_.
- | Or you can pick up a `Task <https://vyos.dev/>`_ and fix the {ref}`code<contributing/development:development>`.
+ | Add missing parts or improve the
+ :ref:`Documentation <documentation:Write Documentation>`.
+ | Discuss in `Slack <https://slack.vyos.io/>`_ or the
+ `Forum <https://forum.vyos.io>`_.
+ | Or you can pick up a `Task <https://vyos.dev/>`_ and fix the
+ :ref:`code <contributing/development:development>`.
```