summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/content/setup/getting-started.md11
-rw-r--r--docs/mkdocs.yml1
2 files changed, 12 insertions, 0 deletions
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 <a href="https://social.hedgedoc.org/" target="_blank" rel="noreferer noopener">:fontawesome-brands-mastodon:{: .mastodon }Mastodon</a> or <a href="https://social.hedgedoc.org/twitter" target="_blank" rel="noreferer noopener">:fontawesome-brands-twitter:{: .twitter }Twitter</a> 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