Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add references to the configuration generator

Browse Source
This commit is contained in:
Joachim Van Herwegen 2023-04-05 10:07:23 +02:00
parent f149e3d884
commit 4b3301738e
3 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -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. to specify how modules and components need to be wired together at runtime.
Examples and guidance on configurations 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). 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 The server allows writing and plugging in custom modules
without altering its base source code. 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/) the [📓 user documentation](https://communitysolidserver.github.io/CommunitySolidServer/)
can help you find your way. can help you find your way.
There is also a repository of [📚 comprehensive tutorials](https://github.com/CommunitySolidServer/tutorials/) There is also a repository of [📚 comprehensive tutorials](https://github.com/CommunitySolidServer/tutorials/)

1
documentation/markdown/README.md
View File

@ -44,6 +44,7 @@ the [changelog](https://github.com/CommunitySolidServer/CommunitySolidServer/blo
## Comprehensive guides and tutorials ## Comprehensive guides and tutorials
* [The CSS tutorial repository](https://github.com/CommunitySolidServer/tutorials/) * [The CSS tutorial repository](https://github.com/CommunitySolidServer/tutorials/)
* [CSS configuration generator](https://communitysolidserver.github.io/configuration-generator/)
## Making changes ## Making changes

11
templates/root/prefilled/index.html
View File

@ -30,13 +30,20 @@
If you want to keep data permanently, If you want to keep data permanently,
choose a configuration that saves data to disk instead. choose a configuration that saves data to disk instead.
</p> </p>
<p>
To learn more about how this server can be used,
have a look at the
<a href="https://github.com/CommunitySolidServer/tutorials/blob/main/getting-started.md">getting started tutorial</a>.
</p>
<h2 id="developers">Getting started as a <em>developer</em></h2> <h2 id="developers">Getting started as a <em>developer</em></h2>
<p> <p>
<a href="./setup">Run the setup</a> to configure your server.
<br>
The default configuration includes The default configuration includes
the <strong>ready-to-use root Pod</strong> you're currently looking at. the <strong>ready-to-use root Pod</strong> you're currently looking at.
<br>
Besides the provided configurations,
you can also fine-tune your own custom configuration using the
<a href="https://communitysolidserver.github.io/configuration-generator/">configuration generator</a>.
</p> </p>
<p> <p>
You can easily choose any folder on your disk You can easily choose any folder on your disk