exampleSite: improve starter configuration #1076

docs/config/_default/hugo.toml

@@ -2,7 +2,7 @@
 # Usable standalone for a fully functioning site
 # or as base values for all other configurations.
 
-# To use run `hugo` or `hugo server`
+# To use run `hugo` or `hugo server` from the `docs` directory
 
 # this is a required setting for this theme to appear on https://themes.gohugo.io/
 # change this to a value appropriate for you; if your site is served from a subdirectory
@@ -22,8 +22,10 @@ relativeURLs = true # true -> rewrite all site-relative URLs (those with a leadi
 # no effect
 uglyURLs = false    # true -> basic/index.html -> basic.html
 
-# the directory where Hugo reads the themes from; this is specific to your
-# installation and most certainly needs be deleted or changed
+# the directory where Hugo reads the theme files from; this is specific to your
+# installation; this configuration here is for running the docs as-is
+# from within the Relearn theme; you need to delete or change it, if you copy the
+# docs to somewhere outside the themes directory
 themesdir = '../..'
 # yeah, well, obviously a mandatory setting for your site, if you want to
 # use this theme ;-)

docs/config/github/hugo.toml

@@ -1,6 +1,6 @@
 # Configuration to release this site on GitHub Pages.
 
-# To use run `hugo -e github` or `hugo server -e github`
+# To use run `hugo -e github` or `hugo server -e github` from the `docs` directory
 
 # For usual GH pages, your website resides in a subdirectory
 # making it necessary to disable headless server mode

docs/config/performance/hugo.toml

@@ -1,6 +1,6 @@
 # This configuration file disables all performance intensive features.
 
-# To use run `hugo -e performance` or `hugo server -e performance`
+# To use run `hugo -e performance` or `hugo server -e performance` from the `docs` directory
 
 # The Piratish pages are slow due to the mechanism used to autotranslate
 # the original english content via the piratify shortcode. This is

docs/config/testing/hugo.toml

@@ -1,7 +1,7 @@
 # Configuration to test the showcase for changes in development
 # This configuration will not result in a functioning website.
 
-# To use run `hugo -e testing` or `hugo server -e testing`
+# To use run `hugo -e testing` or `hugo server -e testing` from the `docs` directory
 
 # We disable this for testing; you must do so too
 # if you want to use the themes parameter disableGeneratorVersion=true;

docs/config/versioning/hugo.toml

@@ -1,6 +1,6 @@
 # Configuration to test versioning support in development
 
-# To use run `hugo -e versioning` or `hugo server -e versioning`
+# To use run `hugo -e versioning` or `hugo server -e versioning` from the `docs` directory
 
 # It uses the docs as the current version and abuses the exampleSite
 # as an archived version

exampleSite/config/_default/hugo.toml

@@ -2,7 +2,7 @@
 # Usable standalone for a fully functioning site
 # or as base values for all other configurations.
 
-# To use run `hugo` or `hugo server`
+# To use run `hugo` or `hugo server` from the `exampleSite` directory
 
 # change this to a value appropriate for you; if your site is served from a subdirectory
 # set it like 'https://example.com/mysite/'
@@ -14,8 +14,11 @@ baseURL = 'https://example.com/'
 # to `false`
 relativeURLs = true # true -> rewrite all site-relative URLs (those with a leading slash) to be relative to the current content
 
-# the directory where Hugo reads the themes from; this is specific to your
-# installation and most certainly needs be deleted or changed
+# the directory where Hugo reads the theme files from; this is specific to your
+# installation; this configuration here is for running the exampleSite as-is
+# from within the Relearn theme; you need to delete or change it, if you copy the
+# exampleSite to somewhere outside the themes directory - which is strongly
+# recommended if you want to use it as a starting point for your project
 themesdir = '../..'
 # yeah, well, obviously a mandatory setting for your site, if you want to
 # use this theme ;-)

exampleSite/config/dev/hugo.toml

@@ -1,8 +1,8 @@
 # Configuration to create a complete website locally, containing of the docs
 # and the exampleSite. This resembles the same structure as the GitHub Pages
 #
-# 1. Build the docs by either `hugo` or `hugo server`
-# 2. Build the exampleSite by `hugo -e dev` or `hugo server -e dev
+# 1. Build the docs by either `hugo` or `hugo server` from the `docs` directory
+# 2. Build the exampleSite by `hugo -e dev` or `hugo server -e dev` from the `exampleSite` directory
 #`
 # After that, a complete website is available in the docs/public folder
 # and can be used from the file system. The links between both projects

exampleSite/config/github/hugo.toml

@@ -1,6 +1,6 @@
 # Configuration to release this site on GitHub Pages.
 
-# To use run `hugo -e github` or `hugo server -e github`
+# To use run `hugo -e github` or `hugo server -e github` from the `exampleSite` directory
 
 # For usual GH pages, your website resides in a subdirectory
 # making it necessary to disable headless server mode

exampleSite/config/performance/hugo.toml

@@ -1,6 +1,6 @@
 # This configuration file disables all performance intensive features.
 
-# To use run `hugo -e performance` or `hugo server -e performance`
+# To use run `hugo -e performance` or `hugo server -e performance` from the `exampleSite` directory
 
 # The Piratish pages are slow due to the mechanism used to autotranslate
 # the original english content via the piratify shortcode. This is

exampleSite/config/testing/hugo.toml

@@ -1,7 +1,7 @@
 # Configuration to test the showcase for changes in development
 # This configuration will not result in a functioning website.
 
-# To use run `hugo -e testing` or `hugo server -e testing`
+# To use run `hugo -e testing` or `hugo server -e testing` from the `exampleSite` directory
 
 # We disable this for testing; you must do so too
 # if you want to use the themes parameter disableGeneratorVersion=true;

exampleSite/config/versioning/hugo.toml

@@ -1,6 +1,6 @@
 # Configuration to test versioning support in development
 
-# To use run `hugo -p 1414 -e versioning` or `hugo server -p 1414 -e versioning`
+# To use run `hugo -p 1414 -e versioning` or `hugo server -p 1414 -e versioning` from the `exampleSite` directory
 
 # It uses the docs as the current version and abuses the exampleSite
 # as an archived version

layouts/partials/version.txt

@@ -1 +1 @@
-7.6.0+3fcfdb2a11ceed7cd2f2eeb755486fffb8fa04bb
+7.6.0+3bb38044a94645e9fcf0a765f0d8df64c02612e2