aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoranarcat <anarcat@users.noreply.github.com>2021-01-21 10:09:44 -0500
committerMantas Vilčinskas <hi@mnts.lt>2021-02-20 23:12:42 +0200
commit68ac06cdd0a22422dbf502f92eace4ef12d86de3 (patch)
treef574233134bd238752d071605f608572d3ca829f
parent1b0c7250efb89f8a021196cc8654e23ce2952441 (diff)
clarify what doesn't work as a baseURL
I was confused when reading the sample config file, as explained in issue #164. "don't support /" could have meant a trailing slash, or subdirectories, or at least wasn't exactly clear to me. By adding an explicit example of a broken behavior, we make it clear what we're talking about here, and what to avoid. Closes: #164
-rw-r--r--exampleSite/config.yml9
1 files changed, 8 insertions, 1 deletions
diff --git a/exampleSite/config.yml b/exampleSite/config.yml
index 3fe6e77..49faaee 100644
--- a/exampleSite/config.yml
+++ b/exampleSite/config.yml
@@ -89,7 +89,14 @@ defaultContentLanguage: en
# version 3. If you are just testing,
# localhost should automatically work.
#
-# Example: https://status.example.com/
+# Example:
+# baseUrl: https://status.example.com/
+#
+# For testing:
+# baseUrl: http://localhost
+#
+# Broken example:
+# baseUrl: /
baseURL: https://cstate.mnts.lt
############################################################