diff --git a/docs/content/introduction/quickstart/_index.en.md b/docs/content/introduction/quickstart/_index.en.md index 4444068774..6345660793 100644 --- a/docs/content/introduction/quickstart/_index.en.md +++ b/docs/content/introduction/quickstart/_index.en.md @@ -7,6 +7,9 @@ weight = 1 Here's how to start your new website. If you're new to Hugo, we recommend learning more about it in its excellent [starter's guide](https://gohugo.io/getting-started/). +> [!note] +> This quickstart is not meant for a production setup. In production you always want to use specific versions of the theme and Hugo. See the [upgrade page](introduction/upgrade) to learn how to obtain a specific version of the theme. + ## Install Hugo Download and install Hugo {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" title=" " %}}0.126.0{{% /badge %}} or newer for your operating system [following the instructions](https://gohugo.io/installation/). diff --git a/docs/content/introduction/upgrade/_index.en.md b/docs/content/introduction/upgrade/_index.en.md index b91ff326f6..05a14b9b66 100644 --- a/docs/content/introduction/upgrade/_index.en.md +++ b/docs/content/introduction/upgrade/_index.en.md @@ -11,6 +11,24 @@ The [releasenotes of the theme](introduction/releasenotes) mention if a newer ve Note, that it is only necessary to upgrade if you are experiencing fixed bugs or want to use new features. It is perfectly fine to stay with arbitrary old versions of Hugo and the theme if everything works for you. +## Semver + +Recent releases of the theme follow the [semver standard](https://semver.org/). + +## Theme Repo Organization + +The `main` branch of the source code repo contains all versions with the development version at the HEAD. This means, pulling from the `main` branch may give you a beta version. + +As this is not suitable for production, the repository contains stable tags for each released version in the form of `7.2.1`. + +In addition, the repository contains floating tags for + +- the latest patch level release of a minor version in the form of `7.2.x` +- the latest minor level release of a major version in the form of `7.x` +- the latest major version in the form of `x` + +Choose a tag that best fits your needs. + ## Planning the Upgrade Depending on your previously used version of Hugo and the theme, you might need to upgrade files of your project. @@ -43,11 +61,11 @@ Remove the old version of the theme by removing the `themes/hugo-theme-relearn` Download the .zip archive of a certain version of the theme and unzip it into the `themes/hugo-theme-relearn` directory -Eg. to upgrade to version 7.2.1 download from [https://github.com/McShelby/hugo-theme-relearn/releases/tag/7.2.1](https://github.com/McShelby/hugo-theme-relearn/releases/tag/7.2.1) +Eg. to upgrade to version 7.2.1 download from [https://github.com/McShelby/hugo-theme-relearn/releases/tag/7.2.1](https://github.com/McShelby/hugo-theme-relearn/releases/tag/7.2.1) ### Use Hugo's Module System -Upgrade the Relearn theme using [Hugo's module system](https://gohugo.io/hugo-modules/use-modules/#upgrade-one-module) to a certain version. +Upgrade the Relearn theme using [Hugo's module system](https://gohugo.io/hugo-modules/use-modules/#update-one-module) to a certain version. Eg. to upgrade to version 7.2.1 diff --git a/layouts/partials/version.txt b/layouts/partials/version.txt index e2c18c062a..e18565b8b1 100644 --- a/layouts/partials/version.txt +++ b/layouts/partials/version.txt @@ -1 +1 @@ -7.5.0+75d9bc2b2ef443f15cd428a046ca249dcde58131 \ No newline at end of file +7.5.0+e2e744670505d811052087baa4b08325d777bf9b \ No newline at end of file