From fa54a080fac977157454beb0853daf0ac0e6af66 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Sat, 2 May 2026 17:25:47 +0300 Subject: feat(swap): import .md files and webp transition from myst/current MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Selective import from origin/myst/current (cf9c9b34): - Add/update 255 .md files (full MyST conversion plus webp ref updates) - Delete 175 PNG/JPG from docs/_static/images (webp twins already present) - Delete 5 autotest topology.png (webp twins already present) Preserved on swap (untouched): - All .rst files (incremental swap pattern) - conf.py, _ext/, _include/*.txt, .gitignore - 115 canary md-*.md files - 7 superpowers/specs/*.md design docs - Logos vyos-logo.png / vyos-logo-icon.png (referenced by conf.py) 🤖 Generated by [robots](https://vyos.io) --- docs/index.md | 113 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 113 insertions(+) create mode 100644 docs/index.md (limited to 'docs/index.md') diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..359fea44 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,113 @@ +(index)= + +# VyOS User Guide + +::::::{grid} 3 +:gutter: 2 + +:::::{grid-item-card} Get / Build VyOS + +Quickly {ref}`Build` +your own Image or take a look at how to +{ref}`download` +a free or supported version. +::::: + +:::::{grid-item-card} Install VyOS + +Read about how to install VyOS on +{ref}`Bare Metal` +or in a {ref}`VM ` +and how to use an image with the usual +{ref}`cloud` +providers +::::: + +:::::{grid-item-card} Configuration and Operation + +Use the {ref}`Quickstart Guide`, +to have a fast overview. Or go deeper and set up +{ref}`advanced routing`, +{ref}`VRFs`, or +{ref}`VPNs` for example. +::::: + +:::::{grid-item-card} Automate + +Integrate VyOS in your automation Workflow with +{ref}`Ansible`, +have your own {ref}`local scripts`, +or configure VyOS with the +{ref}`HTTPS-API`. +::::: + +:::::{grid-item-card} Examples + +Get some inspiration from the +{ref}`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`. + +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`. +::::: +:::::: + +```{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 +``` -- cgit v1.2.3