From dd9781b5f27a7ec894ee38f67f2d793bb83b6075 Mon Sep 17 00:00:00 2001 From: Joachim Van Herwegen Date: Wed, 3 Aug 2022 09:46:53 +0200 Subject: [PATCH] docs: Refactor documentation directory structure --- RELEASE_NOTES.md | 2 +- documentation/markdown/README.md | 18 ++++++++-------- .../{ => architecture}/architecture.md | 4 ++-- .../dependency-injection.md | 0 .../features}/authorization.md | 0 .../features}/resource-store.md | 0 .../{ => contributing}/making-changes.md | 0 .../markdown/{ => contributing}/release.md | 0 .../{ => usage}/client-credentials.md | 0 .../markdown/{ => usage}/example-requests.md | 0 .../markdown/{ => usage}/identity-provider.md | 0 .../markdown/{ => usage}/metadata.md | 0 .../markdown/{ => usage}/seeding-pods.md | 2 +- documentation/mkdocs.yml | 21 +++++++++++-------- 14 files changed, 25 insertions(+), 22 deletions(-) rename documentation/markdown/{ => architecture}/architecture.md (97%) rename documentation/markdown/{ => architecture}/dependency-injection.md (100%) rename documentation/markdown/{ => architecture/features}/authorization.md (100%) rename documentation/markdown/{ => architecture/features}/resource-store.md (100%) rename documentation/markdown/{ => contributing}/making-changes.md (100%) rename documentation/markdown/{ => contributing}/release.md (100%) rename documentation/markdown/{ => usage}/client-credentials.md (100%) rename documentation/markdown/{ => usage}/example-requests.md (100%) rename documentation/markdown/{ => usage}/identity-provider.md (100%) rename documentation/markdown/{ => usage}/metadata.md (100%) rename documentation/markdown/{ => usage}/seeding-pods.md (91%) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 4dc5989e8..f113c290b 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -4,7 +4,7 @@ ### New features - Metadata of resources can now be edited by PATCHing its description resource. This has an impact on which requests are allowed. - See the [documentation](https://communitysolidserver.github.io/CommunitySolidServer/5.0/metadata.md) for more information. + See the [documentation](https://communitysolidserver.github.io/CommunitySolidServer/5.0/usage/metadata/) for more information. - Components.js was upgraded to v5. If you have created an external component you should also upgrade to prevent warnings and conflicts. - The server can now run multithreaded with multiple workers. This is done with the `--workers` or `-w` flag. diff --git a/documentation/markdown/README.md b/documentation/markdown/README.md index 94d1a1428..fb07060d4 100644 --- a/documentation/markdown/README.md +++ b/documentation/markdown/README.md @@ -29,21 +29,21 @@ the [changelog](https://github.com/CommunitySolidServer/CommunitySolidServer/blo ## Using the server - * [Basic example HTTP requests](example-requests.md) - * [Editing the metadata of a resource](metadata.md) - * [How to use the Identity Provider](identity-provider.md) - * [How to automate authentication](client-credentials.md) - * [How to automatically seed pods on startup](seeding-pods.md) + * [Basic example HTTP requests](usage/example-requests.md) + * [Editing the metadata of a resource](usage/metadata.md) + * [How to use the Identity Provider](usage/identity-provider.md) + * [How to automate authentication](usage/client-credentials.md) + * [How to automatically seed pods on startup](usage/seeding-pods.md) ## What the internals look like - * [How the server uses dependency injection](dependency-injection.md) - * [What the architecture looks like](architecture.md) + * [How the server uses dependency injection](architecture/dependency-injection.md) + * [What the architecture looks like](architecture/architecture.md) ## Making changes - * [How to make changes to the repository](making-changes.md) + * [How to make changes to the repository](contributing/making-changes.md) For core developers with push access only: - * [How to release a new version](release.md) + * [How to release a new version](contributing/release.md) diff --git a/documentation/markdown/architecture.md b/documentation/markdown/architecture/architecture.md similarity index 97% rename from documentation/markdown/architecture.md rename to documentation/markdown/architecture/architecture.md index 94d48edda..0aa956e8b 100644 --- a/documentation/markdown/architecture.md +++ b/documentation/markdown/architecture/architecture.md @@ -69,5 +69,5 @@ The `ErrorHandler` will convert the error to an HTTP response to be returned. Below are sections that go deeper into the specific steps. Not all steps are covered yet and will be added in the future. -* [How authentication and authorization work](authorization.md) -* [What the `ResourceStore` looks like](resource-store.md) +* [How authentication and authorization work](features/authorization.md) +* [What the `ResourceStore` looks like](features/resource-store.md) diff --git a/documentation/markdown/dependency-injection.md b/documentation/markdown/architecture/dependency-injection.md similarity index 100% rename from documentation/markdown/dependency-injection.md rename to documentation/markdown/architecture/dependency-injection.md diff --git a/documentation/markdown/authorization.md b/documentation/markdown/architecture/features/authorization.md similarity index 100% rename from documentation/markdown/authorization.md rename to documentation/markdown/architecture/features/authorization.md diff --git a/documentation/markdown/resource-store.md b/documentation/markdown/architecture/features/resource-store.md similarity index 100% rename from documentation/markdown/resource-store.md rename to documentation/markdown/architecture/features/resource-store.md diff --git a/documentation/markdown/making-changes.md b/documentation/markdown/contributing/making-changes.md similarity index 100% rename from documentation/markdown/making-changes.md rename to documentation/markdown/contributing/making-changes.md diff --git a/documentation/markdown/release.md b/documentation/markdown/contributing/release.md similarity index 100% rename from documentation/markdown/release.md rename to documentation/markdown/contributing/release.md diff --git a/documentation/markdown/client-credentials.md b/documentation/markdown/usage/client-credentials.md similarity index 100% rename from documentation/markdown/client-credentials.md rename to documentation/markdown/usage/client-credentials.md diff --git a/documentation/markdown/example-requests.md b/documentation/markdown/usage/example-requests.md similarity index 100% rename from documentation/markdown/example-requests.md rename to documentation/markdown/usage/example-requests.md diff --git a/documentation/markdown/identity-provider.md b/documentation/markdown/usage/identity-provider.md similarity index 100% rename from documentation/markdown/identity-provider.md rename to documentation/markdown/usage/identity-provider.md diff --git a/documentation/markdown/metadata.md b/documentation/markdown/usage/metadata.md similarity index 100% rename from documentation/markdown/metadata.md rename to documentation/markdown/usage/metadata.md diff --git a/documentation/markdown/seeding-pods.md b/documentation/markdown/usage/seeding-pods.md similarity index 91% rename from documentation/markdown/seeding-pods.md rename to documentation/markdown/usage/seeding-pods.md index 079a29c40..3063064a4 100644 --- a/documentation/markdown/seeding-pods.md +++ b/documentation/markdown/usage/seeding-pods.md @@ -18,7 +18,7 @@ For example: ``` You may optionally specify other parameters -as described in the [Identity Provider documentation](./identity-provider.md#json-api). +as described in the [Identity Provider documentation](identity-provider.md#json-api). For example, to set up a pod without registering the generated WebID with the Identity Provider: ```json diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml index 72bd2deca..8d73187a4 100644 --- a/documentation/mkdocs.yml +++ b/documentation/mkdocs.yml @@ -73,17 +73,20 @@ nav: - Welcome: - README.md - Usage: - - Example request: example-requests.md - - Metadata: metadata.md - - Identity provider: identity-provider.md - - Client credentials: client-credentials.md - - Seeding pods: seeding-pods.md + - Example request: usage/example-requests.md + - Metadata: usage/metadata.md + - Identity provider: usage/identity-provider.md + - Client credentials: usage/client-credentials.md + - Seeding pods: usage/seeding-pods.md - Architecture: - - Architecture: architecture.md - - Dependency injection: dependency-injection.md + - Architecture: architecture/architecture.md + - Dependency injection: architecture/dependency-injection.md + - Features: + - Authorization: architecture/features/authorization.md + - Resource Store: architecture/features/resource-store.md - Contributing: - - Pull requests: making-changes.md - - Releases: release.md + - Pull requests: contributing/making-changes.md + - Releases: contributing/release.md - API: ./docs/" target="_blank # To write documentation locally, execute the next line and browse to http://localhost:8000