docs: describe update process #981

exampleSite/content/configuration/sitemanagement/structure/_index.en.md

@@ -28,7 +28,7 @@ By default, it puts your root directory on top of the Relearn theme directory. F
 
 For example, if you create a file at `layouts/partials/heading.html`, it will override the theme's `themes/hugo-theme-relearn/layouts/partials/heading.html`.
 
-[See this list](configuration/customization/partials), to learn which files are allowed to be modified by you.
+[See this list](configuration/customization/partials), to learn which files are allowed to be overridden by you.
 
 This makes it easy to customize the theme without changing files in the `themes` directory, making future theme updates simpler.
 

exampleSite/content/introduction/changelog/_index.en.md

@@ -5,7 +5,7 @@ description = "The detailed changelog"
 disableToc = false
 title = "Changelog"
 type = "changelog"
-weight = 4
+weight = 5
 +++
 
 {{% pages showdivider="true" showhidden="true" hidevisible="true" showtitle="true" %}}

exampleSite/content/introduction/changelog/_index.pir.md

@@ -5,6 +5,6 @@ description = "The detailed changelog"
 disableToc = false
 title = "Changelog"
 type = "changelog"
-weight = 4
+weight = 5
 +++
 {{< piratify >}}

exampleSite/content/introduction/quickstart/_index.en.md

@@ -27,7 +27,7 @@ Then move into the new directory
 cd my-new-site
 ````
 
-Run all future commands from this directory.
+Run all following commands from this directory.
 
 ## Install the Theme
 

exampleSite/content/introduction/releasenotes/_index.en.md

@@ -5,7 +5,7 @@ description = "What's new in this version"
 disableToc = false
 title = "What's New"
 type = "releasenotes"
-weight = 3
+weight = 4
 +++
 
 {{% pages showdivider="true" showhidden="true" hidevisible="true" showtitle="true" %}}

exampleSite/content/introduction/releasenotes/_index.pir.md

@@ -5,6 +5,6 @@ description = "What's new in this version"
 disableToc = false
 title = "What's New"
 type = "releasenotes"
-weight = 3
+weight = 4
 +++
 {{< piratify >}}

exampleSite/content/introduction/tools/_index.en.md

@@ -2,7 +2,7 @@
 categories = ["howto"]
 description = "All about supported 3rd party tools"
 title = "Tool Integration"
-weight = 2
+weight = 3
 +++
 
 ## Front Matter CMS

exampleSite/content/introduction/tools/_index.pir.md

@@ -2,6 +2,6 @@
 categories = ["howto"]
 description = "All about supported 3rd party tools"
 title = "Tool Integration"
-weight = 2
+weight = 3
 +++
 {{< piratify >}}

exampleSite/content/introduction/upgrade/_index.en.md

@@ -0,0 +1,61 @@
++++
+categories = ["tutorial"]
+description = "How to upgrade your Relearn site"
+title = "Upgrade"
+weight = 2
++++
+
+Consider Hugo and the theme one unit. If you update the theme, in many cases, you need also to update Hugo and vice versa.
+
+The [releasenotes of the theme](introduction/releasenotes) mention if a newer version of Hugo is required.
+
+Note, that it is only necessary to update 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.
+
+## Planning the Update
+
+Depending on your previously used version of Hugo and the theme, you might need to update files of your project.
+
+Usually the [releasenotes of the theme](introduction/releasenotes) help you with theme related changes.
+
+During build of your project the console may show further warnings or errors with hints of what's wrong and how to fix it.
+
+Note that these [hints may be removed after a while](https://gohugo.io/troubleshooting/deprecation) by Hugo or the theme. In case you are updating from rather far beyond versions, consider to do the update in steps:
+
+Say, you are using Relearn 4.0.1 and want to update your project to the latest version (say 7.2.1):
+
+- find out the [last theme release of version 4](introduction/changelog/4) (which is 4.2.5) and the [required Hugo version](introduction/releasenotes/4) (at least 0.93.0, [taken from the releasenotes of version 3](introduction/releasenotes/3) as version 4 did not raise the Hugo version) and update
+- run `hugo server` and fix any errors
+- find out the [last theme release of version 5](introduction/changelog/5) (which is 5.27.0) and the [required Hugo version](introduction/releasenotes/5) (at least 0.121.0) and update
+- run `hugo server` and fix any errors
+- etc. until done
+
+This procedure may lead to more work than updating in one single step, but it will be far easier to fix errors and can be divided into smaller units of work.
+
+## Update the Theme
+
+Updating the theme depends on the way [how you've installed it](introduction/quickstart#install-the-theme).
+
+Run all following commands from the root of your Hugo project.
+
+### Download as a Zip File
+
+- Remove the old version of the theme by removing the `themes/hugo-theme-relearn` directory.
+- [Pick a certain version](https://github.com/McShelby/hugo-theme-relearn/releases) of theme, download it as a .zip file and unzip it into the `themes/hugo-theme-relearn` directory
+
+### Use Hugo's Module System
+
+Update the Relearn theme using [Hugo's module system](https://gohugo.io/hugo-modules/use-modules/#update-one-module) to a certain version. Eg. to update to version 7.2.1
+
+````shell
+hugo mod get -u github.com/McShelby/hugo-theme-relearn@7.2.1
+````
+
+### Use as a Git Submodule
+
+Update the Relearn theme using [Git](https://git-scm.com/) to a certain version. Eg. to update to version 7.2.1
+
+````shell
+git submodule update --remote --depth 1 --force themes/hugo-theme-relearn
+git -C themes/hugo-theme-relearn fetch --tags
+git -C themes/hugo-theme-relearn checkout 7.2.1
+````

exampleSite/content/introduction/upgrade/_index.pir.md

@@ -0,0 +1,7 @@
++++
+categories = ["tutorial"]
+description = "How to upgrade your Relearn site"
+title = "Upgrade"
+weight = 2
++++
+{{< piratify >}}

layouts/partials/version.txt

@@ -1 +1 @@
-7.2.1+2e198810a95fdbff698c2180edd4e14a4fabab0f
+7.2.1+6747b8862e1ea7331662a6376ef02a48126816ae