From 24dbc23ab08eec85d281505439c1a40903f8e6c0 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Wed, 3 Mar 2021 13:51:39 +0100 Subject: Docs: Add a note about upgrading to the getting started guide Signed-off-by: David Mehren --- docs/content/setup/getting-started.md | 11 +++++++++++ docs/mkdocs.yml | 1 + 2 files changed, 12 insertions(+) diff --git a/docs/content/setup/getting-started.md b/docs/content/setup/getting-started.md index a8180793..3592b6bb 100644 --- a/docs/content/setup/getting-started.md +++ b/docs/content/setup/getting-started.md @@ -8,3 +8,14 @@ To set up your instance follow these steps: 3. [Configure HedgeDoc](https://docs.hedgedoc.org/configuration/) Follow us on :fontawesome-brands-mastodon:{: .mastodon }Mastodon or :fontawesome-brands-twitter:{: .twitter }Twitter for updates. + +## Upgrading HedgeDoc + +HedgeDoc follows [Semantic Versioning](https://semver.org/). +This means that minor and patch releases should not introduce user-facing backwards-incompatible changes. + +You can find more details about upgrading in the instructions of your installation method. + +!!! warning + Before you upgrade, **always read the release notes**. + You can find them on our [releases page](https://hedgedoc.org/releases/). diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 5b04cc40..8268ee5b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -60,6 +60,7 @@ markdown_extensions: emoji_generator: !!python/name:materialx.emoji.to_svg - attr_list - footnotes + - admonition theme: name: 'material' language: en -- cgit v1.2.3