mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
docs: Refactor documentation directory structure
This commit is contained in:
parent
3e9989ee1b
commit
dd9781b5f2
@ -4,7 +4,7 @@
|
|||||||
### New features
|
### New features
|
||||||
- Metadata of resources can now be edited by PATCHing its description resource.
|
- Metadata of resources can now be edited by PATCHing its description resource.
|
||||||
This has an impact on which requests are allowed.
|
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
|
- Components.js was upgraded to v5. If you have created an external component
|
||||||
you should also upgrade to prevent warnings and conflicts.
|
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.
|
- The server can now run multithreaded with multiple workers. This is done with the `--workers` or `-w` flag.
|
||||||
|
@ -29,21 +29,21 @@ the [changelog](https://github.com/CommunitySolidServer/CommunitySolidServer/blo
|
|||||||
|
|
||||||
## Using the server
|
## Using the server
|
||||||
|
|
||||||
* [Basic example HTTP requests](example-requests.md)
|
* [Basic example HTTP requests](usage/example-requests.md)
|
||||||
* [Editing the metadata of a resource](metadata.md)
|
* [Editing the metadata of a resource](usage/metadata.md)
|
||||||
* [How to use the Identity Provider](identity-provider.md)
|
* [How to use the Identity Provider](usage/identity-provider.md)
|
||||||
* [How to automate authentication](client-credentials.md)
|
* [How to automate authentication](usage/client-credentials.md)
|
||||||
* [How to automatically seed pods on startup](seeding-pods.md)
|
* [How to automatically seed pods on startup](usage/seeding-pods.md)
|
||||||
|
|
||||||
## What the internals look like
|
## What the internals look like
|
||||||
|
|
||||||
* [How the server uses dependency injection](dependency-injection.md)
|
* [How the server uses dependency injection](architecture/dependency-injection.md)
|
||||||
* [What the architecture looks like](architecture.md)
|
* [What the architecture looks like](architecture/architecture.md)
|
||||||
|
|
||||||
## Making changes
|
## 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:
|
For core developers with push access only:
|
||||||
|
|
||||||
* [How to release a new version](release.md)
|
* [How to release a new version](contributing/release.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.
|
Below are sections that go deeper into the specific steps.
|
||||||
Not all steps are covered yet and will be added in the future.
|
Not all steps are covered yet and will be added in the future.
|
||||||
|
|
||||||
* [How authentication and authorization work](authorization.md)
|
* [How authentication and authorization work](features/authorization.md)
|
||||||
* [What the `ResourceStore` looks like](resource-store.md)
|
* [What the `ResourceStore` looks like](features/resource-store.md)
|
@ -18,7 +18,7 @@ For example:
|
|||||||
```
|
```
|
||||||
|
|
||||||
You may optionally specify other parameters
|
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:
|
For example, to set up a pod without registering the generated WebID with the Identity Provider:
|
||||||
```json
|
```json
|
@ -73,17 +73,20 @@ nav:
|
|||||||
- Welcome:
|
- Welcome:
|
||||||
- README.md
|
- README.md
|
||||||
- Usage:
|
- Usage:
|
||||||
- Example request: example-requests.md
|
- Example request: usage/example-requests.md
|
||||||
- Metadata: metadata.md
|
- Metadata: usage/metadata.md
|
||||||
- Identity provider: identity-provider.md
|
- Identity provider: usage/identity-provider.md
|
||||||
- Client credentials: client-credentials.md
|
- Client credentials: usage/client-credentials.md
|
||||||
- Seeding pods: seeding-pods.md
|
- Seeding pods: usage/seeding-pods.md
|
||||||
- Architecture:
|
- Architecture:
|
||||||
- Architecture: architecture.md
|
- Architecture: architecture/architecture.md
|
||||||
- Dependency injection: dependency-injection.md
|
- Dependency injection: architecture/dependency-injection.md
|
||||||
|
- Features:
|
||||||
|
- Authorization: architecture/features/authorization.md
|
||||||
|
- Resource Store: architecture/features/resource-store.md
|
||||||
- Contributing:
|
- Contributing:
|
||||||
- Pull requests: making-changes.md
|
- Pull requests: contributing/making-changes.md
|
||||||
- Releases: release.md
|
- Releases: contributing/release.md
|
||||||
- API: ./docs/" target="_blank
|
- API: ./docs/" target="_blank
|
||||||
|
|
||||||
# To write documentation locally, execute the next line and browse to http://localhost:8000
|
# To write documentation locally, execute the next line and browse to http://localhost:8000
|
||||||
|
Loading…
x
Reference in New Issue
Block a user