From 4b3301738e3884a3b4324982c324463a1beb990c Mon Sep 17 00:00:00 2001
From: Joachim Van Herwegen
Date: Wed, 5 Apr 2023 10:07:23 +0200
Subject: [PATCH] docs: Add references to the configuration generator
---
README.md | 6 ++++--
documentation/markdown/README.md | 1 +
templates/root/prefilled/index.html | 11 +++++++++--
3 files changed, 14 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 5154d32e5..abdeb98ad 100644
--- a/README.md
+++ b/README.md
@@ -167,7 +167,9 @@ The Community Solid Server uses [Components.js](https://componentsjs.readthedocs
to specify how modules and components need to be wired together at runtime.
Examples and guidance on configurations
-are available in the [`config` folder](https://github.com/CommunitySolidServer/CommunitySolidServer/tree/main/config).
+are available in the [`config` folder](https://github.com/CommunitySolidServer/CommunitySolidServer/tree/main/config),
+and the [configurations tutorial](https://github.com/CommunitySolidServer/tutorials/blob/main/custom-configurations.md).
+There is also a [configuration generator](https://communitysolidserver.github.io/configuration-generator/).
Recipes for configuring the server can be found at [CommunitySolidServer/recipes](https://github.com/CommunitySolidServer/recipes).
@@ -176,7 +178,7 @@ Recipes for configuring the server can be found at [CommunitySolidServer/recipes
The server allows writing and plugging in custom modules
without altering its base source code.
-The [📗 API documentation](https://communitysolidserver.github.io/CommunitySolidServer/latest/5.x/docs) and
+The [📗 API documentation](https://communitysolidserver.github.io/CommunitySolidServer/5.x/docs) and
the [📓 user documentation](https://communitysolidserver.github.io/CommunitySolidServer/)
can help you find your way.
There is also a repository of [📚 comprehensive tutorials](https://github.com/CommunitySolidServer/tutorials/)
diff --git a/documentation/markdown/README.md b/documentation/markdown/README.md
index e2843ded4..66b59a84d 100644
--- a/documentation/markdown/README.md
+++ b/documentation/markdown/README.md
@@ -44,6 +44,7 @@ the [changelog](https://github.com/CommunitySolidServer/CommunitySolidServer/blo
## Comprehensive guides and tutorials
* [The CSS tutorial repository](https://github.com/CommunitySolidServer/tutorials/)
+* [CSS configuration generator](https://communitysolidserver.github.io/configuration-generator/)
## Making changes
diff --git a/templates/root/prefilled/index.html b/templates/root/prefilled/index.html
index 0c6e0376c..20c0e0702 100644
--- a/templates/root/prefilled/index.html
+++ b/templates/root/prefilled/index.html
@@ -30,13 +30,20 @@
If you want to keep data permanently,
choose a configuration that saves data to disk instead.
+
+ To learn more about how this server can be used,
+ have a look at the
+ getting started tutorial.
+
Getting started as a developer
- Run the setup to configure your server.
-
The default configuration includes
the ready-to-use root Pod you're currently looking at.
+
+ Besides the provided configurations,
+ you can also fine-tune your own custom configuration using the
+ configuration generator.
You can easily choose any folder on your disk