Dev Docs: Add configuration to navigation

This makes it possible to access the developer documentation about configuration code.

Signed-off-by: Philip Molares <philip.molares@udo.edu>

.env.example

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
+#
+# SPDX-License-Identifier: CC0-1.0
+
 HD_DOMAIN="http://localhost"
 HD_MEDIA_BACKEND="filesystem"
 HD_MEDIA_BACKEND_FILESYSTEM_UPLOAD_PATH="upload/"

docs/content/dev/config.md

@@ -30,19 +30,19 @@ The config of HedgeDoc is split up into **six** different modules:
 
 Each of those files (except `auth.config.ts` which is discussed later) consists of three parts:
 
-1. An Interface
+1. An interface
 2. A Joi schema
 3. A default export
 
 ### Interface
 
-The interface just describes what options the configuration has and how the rest of HedgeDoc can use them. All enums that are used in here are put in their own files with the extension `.enum.ts`.
+The interface just describes which options the configuration has and how the rest of HedgeDoc can use them. All enums that are used in here are put in their own files with the extension `.enum.ts`.
 
 ### Joi Schema
 
-We use [Joi][joi] to validate each provided configuration to make sure the configuration of the user is sound and provide helpful error messages if that's not the case.
+We use [Joi][joi] to validate each provided configuration to make sure the configuration of the user is sound and provides helpful error messages otherwise.
 
-The most important part here is that each value has a `.label()` at the end. With this the environment variable name that corresponds to each config option is described. It's very important that each config options is given the correct label to have meaningful error messages that benefit the user.
+The most important part here is that each value ends with `.label()`. This names the environment variable that corresponds to each config option. It's very important that each config option is assigned the correct label to have meaningful error messages that benefit the user.
 
 Everything else about how Joi works and how you should write schemas can be read in [their documentation][joi-doc].
 
@@ -52,21 +52,20 @@ The default exports are used by NestJS to provide the values to the rest of the
 
 1. Populate the config interface with environment variables, creating the config object.
 2. Validate the config object against the Joi schema.
-3. Work on the error messages from Joi and present them to the user (if any occur).
+3. Polish the error messages from Joi and present them to the user (if any occur).
 4. Return the validated config object.
 
 ## How `auth.config.ts` works
 
-Because it's possible to configure some authentication provider more than once (multiple LDAPs, multiple GitLabs) and we don't know how many, we use user defined environment variable names. With the user defined names it's not possible to put the correct labels in the schema or build the config objects as we do in every other file.
+Because it's possible to configure some authentication providers multiple times (e.g. multiple LDAPs or GitLabs), we use user defined environment variable names. With the user defined names it's not possible to put the correct labels in the schema or build the config objects as we do in every other file.
 
 Therefore, we have two big extra steps in the default export:
 1. To populate the config object we have some code at the top of the default export to gather all configured variables into arrays. 
-2. The error messages are piped into the util method `replaceAuthErrorsWithEnvironmentVariables`.  This replaces the error messages of the form `gitlab[0].providerName` with `HD_AUTH_GITLAB_<nameOfFirstGitlab>_PROVIDER_NAME`. For this the util functions gets the error, the name of the config option (e.g `'gitlab'`), the approriate prefix (e.g. `'HD_AUTH_GITLAB_'`), and an array of the user defined names.
+2. The error messages are piped into the util method `replaceAuthErrorsWithEnvironmentVariables`.  This replaces the error messages of the form `gitlab[0].providerName` with `HD_AUTH_GITLAB_<nameOfFirstGitlab>_PROVIDER_NAME`. For this the util function gets the error, the name of the config option (e.g `'gitlab'`), the approriate prefix (e.g. `'HD_AUTH_GITLAB_'`), and an array of the user defined names.
 
 ## Mocks
 
-Some config files also have a `.mock.ts` file in which the configuration for the e2e tests is defined. Those files just contain the default export and returns the mock config object.
-
+Some config files also have a `.mock.ts` file which defines the configuration for the e2e tests. Those files just contain the default export and return the mock config object.
 
 [csp]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP
 [hsts]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security

docs/mkdocs.yml

@@ -9,6 +9,7 @@ nav:
   - Home: index.md
   - Developer:
       - '2.0 Development': dev/2.0.md
+      - Configuration: dev/config.md
       - 'Documentation': dev/documentation.md
   - FAQ: https://hedgedoc.org/faq
 markdown_extensions: