From c9f8285f571182b869987f94cb8e7f54636d6492 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Sun, 12 Mar 2023 20:40:47 +0100 Subject: [PATCH] docs: Move 'Configuration' to design docs Signed-off-by: David Mehren --- docs/content/dev/{ => design_docs}/config.md | 10 ++++++---- docs/mkdocs.yml | 2 +- 2 files changed, 7 insertions(+), 5 deletions(-) rename docs/content/dev/{ => design_docs}/config.md (91%) diff --git a/docs/content/dev/config.md b/docs/content/dev/design_docs/config.md similarity index 91% rename from docs/content/dev/config.md rename to docs/content/dev/design_docs/config.md index eead4f2f6..0fe6949c0 100644 --- a/docs/content/dev/config.md +++ b/docs/content/dev/design_docs/config.md @@ -1,10 +1,12 @@ # Config -The configuration of HedgeDoc is handled entirely by environment variables. Most of these variables are prefixed with `HD_` (for HedgeDoc). +!!! info "Design Document" + This is a design document, explaining the design and vision for a HedgeDoc 2 + feature. It is not a user guide and may or may not be fully implemented. -## Configuring HedgeDoc for development - -NestJS - the framework we use - is reading the variables from the environment and also from the `.env` file in the root of the project. To make it easy to get the project started we included an example `.env` file in the root of this project called `.env.example`. +The configuration of HedgeDoc 2 is handled entirely by environment variables. +Most of these variables are prefixed with `HD_` (for HedgeDoc). +NestJS - the framework we use - is reading the variables from the environment and also from the `.env` file in the root of the project. ## How the config code works diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ff03c7911..0c565c236 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -24,7 +24,7 @@ nav: - Design Documents: - Notes: dev/notes.md - 'User Profiles & Authentication': dev/design_docs/user_profiles.md - - Configuration: dev/config.md + - Configuration: dev/design_docs/config.md - 'Writing Docs': dev/documentation.md - FAQ: https://hedgedoc.org/faq markdown_extensions: