diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-02 18:59:58 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-06 16:18:03 +0300 |
| commit | 5a35f4d30e5c16bd85e811176cffa86b721112b7 (patch) | |
| tree | 8339f5c27d85b97196825e825f4139fe4827876c /docs/md-index.md | |
| parent | 38ff65941d6cd771700480fd2e6c88dad6a01c24 (diff) | |
| download | vyos-documentation-5a35f4d30e5c16bd85e811176cffa86b721112b7.tar.gz vyos-documentation-5a35f4d30e5c16bd85e811176cffa86b721112b7.zip | |
refactor(swap): rename imported .md files to md- prefix for swap mechanism
Restore the canary file naming convention that swap_sources.py expects:
the imported MyST pages now live as docs/<dir>/md-<name>.md alongside
the existing docs/<dir>/<name>.rst, so swap_sources.py --swap can rename
them into place at build time.
- 254 .md files renamed (every page with a matching .rst counterpart)
- 2 MyST-only pages left at their final names (no .rst exists, no swap
needed): docs/copyright.md, docs/automation/terraform/terraformvyos.md
All 114 stems listed in docs/_swap.txt now have a corresponding
md-<name>.md source file ready to swap in.
🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/md-index.md')
| -rw-r--r-- | docs/md-index.md | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/docs/md-index.md b/docs/md-index.md new file mode 100644 index 00000000..359fea44 --- /dev/null +++ b/docs/md-index.md @@ -0,0 +1,113 @@ +(index)= + +# VyOS User Guide + +::::::{grid} 3 +:gutter: 2 + +:::::{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. +::::: + +:::::{grid-item-card} Install VyOS + +Read about how to install VyOS on +{ref}`Bare Metal<installation/install:installation>` +or in a {ref}`VM <installation/virtual/index:Virtual Environments>` +and how to use an image with the usual +{ref}`cloud<installation/cloud/index: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. +::::: + +:::::{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>`. +::::: + +:::::{grid-item-card} Examples + +Get some inspiration from the +{ref}`Blueprints <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>`. +::::: +:::::: + +```{toctree} +:hidden: true +:maxdepth: 1 + +introducing/about +introducing/history +``` + +```{toctree} +:caption: First Steps +:hidden: true +:maxdepth: 2 + +installation/index +quick-start +cli +``` + +```{toctree} +:caption: Adminguide +:hidden: true +:maxdepth: 2 + +configuration/index +operation/index +automation/index +troubleshooting/index +configexamples/index +vpp/index +``` + +```{toctree} +:caption: Development +:hidden: true +:maxdepth: 2 + +contributing/index +``` + +```{toctree} +:caption: Misc +:hidden: true +:maxdepth: 2 + +documentation +coverage +copyright +``` |
