From 162a8e8816b962448a3bf8f0f794643aaee3cf31 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Sun, 12 Mar 2023 20:32:19 +0100 Subject: [PATCH] docs: Move 'User Profiles & Authentication' to design docs Signed-off-by: David Mehren --- backend/src/identity/identity.entity.ts | 2 +- .../dev/{authentication.md => design_docs/user_profiles.md} | 5 +++++ docs/mkdocs.yml | 2 +- 3 files changed, 7 insertions(+), 2 deletions(-) rename docs/content/dev/{authentication.md => design_docs/user_profiles.md} (95%) diff --git a/backend/src/identity/identity.entity.ts b/backend/src/identity/identity.entity.ts index 529dd16e2..66cf3c2f1 100644 --- a/backend/src/identity/identity.entity.ts +++ b/backend/src/identity/identity.entity.ts @@ -52,7 +52,7 @@ export class Identity { /** * If the identity should be used as the sync source. - * See [authentication doc](../../docs/content/dev/authentication.md) for clarification + * See [authentication doc](../../docs/content/dev/user_profiles.md) for clarification */ @Column() syncSource: boolean; diff --git a/docs/content/dev/authentication.md b/docs/content/dev/design_docs/user_profiles.md similarity index 95% rename from docs/content/dev/authentication.md rename to docs/content/dev/design_docs/user_profiles.md index f2354e99b..e4a1b0016 100644 --- a/docs/content/dev/authentication.md +++ b/docs/content/dev/design_docs/user_profiles.md @@ -1,4 +1,9 @@ # User Profiles and Authentication + +!!! 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. + Each user in HedgeDoc 2 has a profile which contains the following information: diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index dd927b32f..ff03c7911 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -23,7 +23,7 @@ nav: - '2.0 Development': dev/2.0.md - Design Documents: - Notes: dev/notes.md - - 'User Profiles & Authentication': dev/user_profiles.md + - 'User Profiles & Authentication': dev/design_docs/user_profiles.md - Configuration: dev/config.md - 'Writing Docs': dev/documentation.md - FAQ: https://hedgedoc.org/faq