Docs: Add a note about upgrading to the getting started guide

Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2021-03-03 13:51:39 +01:00
parent 3e161c612f
commit 24dbc23ab0
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
2 changed files with 12 additions and 0 deletions

View file

@ -8,3 +8,14 @@ To set up your instance follow these steps:
3. [Configure HedgeDoc](https://docs.hedgedoc.org/configuration/) 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. 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/).

View file

@ -60,6 +60,7 @@ markdown_extensions:
emoji_generator: !!python/name:materialx.emoji.to_svg emoji_generator: !!python/name:materialx.emoji.to_svg
- attr_list - attr_list
- footnotes - footnotes
- admonition
theme: theme:
name: 'material' name: 'material'
language: en language: en