summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2021-02-06 01:44:22 +0100
committerChristian Poessinger <christian@poessinger.com>2021-02-06 01:45:15 +0100
commitadddcd684179bbe9a1be359036995542b9cbade6 (patch)
treef6f6b831a36e4ef19353894711ff070583c2eb45 /README.md
parent33a3a3987159c96c55573b619e07e4307ab0d4a1 (diff)
downloadvyos-documentation-adddcd684179bbe9a1be359036995542b9cbade6.tar.gz
vyos-documentation-adddcd684179bbe9a1be359036995542b9cbade6.zip
README: add link to old Wiki
(cherry picked from commit 8839d72d174f13b53bbc1521d9935df6ae891514)
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 24 insertions, 3 deletions
diff --git a/README.md b/README.md
index 15059831..5c269651 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,33 @@
-Starting with VyOS 1.2 (`crux`) documentation is being migrated from the old wiki
-to ReadTheDocs. Documentation can be accessed via the following URL:
+Starting with VyOS 1.2 (`crux`) our documentation is being migrated from the old wiki
+to ReadTheDocs. Documentation can be accessed via the following URL: https://docs.vyos.io
-* https://docs.vyos.io
+Our old WiKi can still be accessed from the
+[Wayback Machine](https://web.archive.org/web/20200225171529/https://wiki.vyos.net/wiki/Main_Page)
# Build
[![Documentation Status](https://readthedocs.org/projects/vyos/badge/?version=latest)](https://docs.vyos.io/en/latest/?badge=latest)
+# Versions
+
+Our version follows the very same branching scheme as the VyOS source modules
+itself. We maintain one documentation branch per VyOS release. The default
+branch that contains the most recent VyOS documentation is called `master`
+and matches the latest VyOS release which is 1.4 at the time.
+
+All new documentation enhancements go to the `master` branch. If those changes
+are beneficial for previous VyOS documentation versions they will be
+cherry-picked to the appropriate branch(es).
+
+Post-1.2.0 branches are named after constellations sorted by area from smallest to
+largest. There are 88 of them, here's the
+[complete list](https://en.wikipedia.org/wiki/IAU_designated_constellations_by_area).
+
+* 1.2.x: `crux` (Southern Cross)
+* 1.3.x: `equuleus` (Little Horse)
+* 1.4.x: `sagitta` (Arrow)
+* ...
+
## Native
To build the manual, run the following commands inside the `docs` folder: