From 63609404e0f249bb50574d3b7f9f6234ce13a415 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sun, 17 Nov 2019 20:59:01 +0100 Subject: README: update info on ReadTheDocs --- CONTRIBUTING.md | 2 +- README.md | 9 +++++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 67e55734..5ebc233b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ # Documentation Contribution Please follow the guid in our documentation. It can be found here: -https://vyos.readthedocs.io/en/latest/contributing/documentation.html +https://docs.vyos.io/en/latest/contributing/documentation.html diff --git a/README.md b/README.md index 8b8f5931..5dcbde1b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ -This is a playground for a new VyOS documentation starting for VyOS 1.2 (Crux) -release. +Starting with VyOS 1.2 (`crux`) documentation will be migrated from the old wiki +to ReadTheDocs. Documentation can be accessed via the following URLs: + +* https://docs.vyos.io +* https://vyos.readthedocs.org # Build +[![Documentation Status](https://readthedocs.org/projects/vyos/badge/?version=latest)](https://docs.vyos.io/en/latest/?badge=latest) + ## Native To build the manual run the following commands inside the `docs` folder: -- cgit v1.2.3