summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2021-02-05 22:05:59 +0100
committerGitHub <noreply@github.com>2021-02-05 22:05:59 +0100
commit9338efa5982ed4ac082dab8a5d125040c94c2b1a (patch)
tree737ef0f6acb5c9dffd14cc42ae2c813de2593467 /README.md
parent7fb7ae40f4b8546e34e43269e93d51edd3b25cd4 (diff)
downloadvyos-documentation-9338efa5982ed4ac082dab8a5d125040c94c2b1a.tar.gz
vyos-documentation-9338efa5982ed4ac082dab8a5d125040c94c2b1a.zip
README: explain documentation branching scheme
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 15059831..f02f4761 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,26 @@ to ReadTheDocs. Documentation can be accessed via the following URL:
* https://docs.vyos.io
+# 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)
+* ...
+
# Build
[![Documentation Status](https://readthedocs.org/projects/vyos/badge/?version=latest)](https://docs.vyos.io/en/latest/?badge=latest)