diff --git a/exampleSite/content/introduction/upgrade/_index.en.md b/exampleSite/content/introduction/upgrade/_index.en.md index 2a5787ddaa..d002f66a37 100644 --- a/exampleSite/content/introduction/upgrade/_index.en.md +++ b/exampleSite/content/introduction/upgrade/_index.en.md @@ -5,33 +5,33 @@ 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. +Consider Hugo and the theme one unit. If you upgrade the theme, in many cases, you need also to upgrade 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. +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. -## Planning the Update +## Planning the Upgrade -Depending on your previously used version of Hugo and the theme, you might need to update files of your project. +Depending on your previously used version of Hugo and the theme, you might need to upgrade files of your project. -Usually the [releasenotes of the theme](introduction/releasenotes) help you with theme related changes. +The [releasenotes](introduction/releasenotes) announce theme related modifications and help you identifying spots in your files that require 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. +Also watch the console during build of your project, as it 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: +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 upgrade in steps: -Say, you are using Relearn 4.0.1 and want to update your project to the latest version (say 7.2.1): +Say, you are using Relearn 4.0.1 and want to upgrade 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 +- 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 upgrade - 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 +- 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 upgrade - 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. +This procedure may lead to more work than updating in one single step, but it will be far easier to make adaptions and can be divided into smaller units of work. -## Update the Theme +## Upgrade the Theme Updating the theme depends on the way [how you've installed it](introduction/quickstart#install-the-theme). @@ -39,12 +39,17 @@ 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 +Remove the old version of the theme by removing the `themes/hugo-theme-relearn` directory. + +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 go to [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 -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 +Upgrade the Relearn theme using [Hugo's module system](https://gohugo.io/hugo-modules/use-modules/#upgrade-one-module) to a certain version. + +Eg. to upgrade to version 7.2.1 ````shell hugo mod get -u github.com/McShelby/hugo-theme-relearn@7.2.1 @@ -52,10 +57,12 @@ 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 +Upgrade the Relearn theme using [Git](https://git-scm.com/) to a certain version. + +Eg. to upgrade to version 7.2.1 ````shell -git submodule update --remote --depth 1 --force themes/hugo-theme-relearn +git submodule upgrade --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 ```` diff --git a/layouts/partials/version.txt b/layouts/partials/version.txt index 1d88ec520d..62894f0224 100644 --- a/layouts/partials/version.txt +++ b/layouts/partials/version.txt @@ -1 +1 @@ -7.2.1+4d514de8d1594546a3c57cf08e3fa41444f30d46 \ No newline at end of file +7.2.1+83e70121667de9d9b7e2d004fc3792714b48fb40 \ No newline at end of file