diff options
Diffstat (limited to 'docs')
18 files changed, 21 insertions, 21 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 744a076ef1..ceb96b5c6d 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -80,30 +80,30 @@ # Development - [Contributing Guide](development/contributing_guide.md) - - [Code Style](code_style.md) + - [Code Style](development/code_style.md) - [Reviewing Code](development/reviews.md) - [Release Cycle](development/releases.md) - [Git Usage](development/git.md) - [Testing]() - [Demo scripts](development/demo.md) - - [OpenTracing](opentracing.md) + - [OpenTracing](development/opentracing.md) - [Database Schemas](development/database_schema.md) - [Experimental features](development/experimental_features.md) - [Dependency management](development/dependencies.md) - [Synapse Architecture]() - [Cancellation](development/synapse_architecture/cancellation.md) - - [Log Contexts](log_contexts.md) - - [Replication](replication.md) - - [TCP Replication](tcp_replication.md) + - [Log Contexts](development/synapse_architecture/log_contexts.md) + - [Replication](development/synapse_architecture/replication.md) + - [TCP Replication](development/synapse_architecture/tcp_replication.md) - [Internal Documentation](development/internal_documentation/README.md) - [Single Sign-On]() - - [SAML](development/saml.md) - - [CAS](development/cas.md) - - [Room DAG concepts](development/room-dag-concepts.md) + - [SAML](development/internal_documentation/saml.md) + - [CAS](development/internal_documentation/cas.md) + - [Room DAG concepts](development/internal_documentation/room-dag-concepts.md) - [State Resolution]() - - [The Auth Chain Difference Algorithm](auth_chain_difference_algorithm.md) - - [Media Repository](media_repository.md) - - [Room and User Statistics](room_and_user_statistics.md) + - [The Auth Chain Difference Algorithm](development/internal_documentation/auth_chain_difference_algorithm.md) + - [Media Repository](development/internal_documentation/media_repository.md) + - [Room and User Statistics](development/internal_documentation/room_and_user_statistics.md) - [Scripts]() # Other diff --git a/docs/admin_api/media_admin_api.md b/docs/admin_api/media_admin_api.md index d57c5aedae..960c10332f 100644 --- a/docs/admin_api/media_admin_api.md +++ b/docs/admin_api/media_admin_api.md @@ -3,7 +3,7 @@ These APIs allow extracting media information from the homeserver. Details about the format of the `media_id` and storage of the media in the file system -are documented under [media repository](../media_repository.md). +are documented under [media repository](../development/internal_documentation/media_repository.md). To use it, you will need to authenticate by providing an `access_token` for a server admin: see [Admin API](../usage/administration/admin_api). diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md index c95d6c9b05..800a4de441 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md @@ -548,8 +548,8 @@ The following fields are returned in the JSON response body: ### List media uploaded by a user Gets a list of all local media that a specific `user_id` has created. These are media that the user has uploaded themselves -([local media](../media_repository.md#local-media)), as well as -[URL preview images](../media_repository.md#url-previews) requested by the user if the +([local media](../development/internal_documentation/media_repository.md#local-media)), as well as +[URL preview images](../development/internal_documentation/media_repository.md#url-previews) requested by the user if the [feature is enabled](../usage/configuration/config_documentation.md#url_preview_enabled). By default, the response is ordered by descending creation date and ascending media ID. @@ -650,7 +650,7 @@ The following fields are returned in the JSON response body: - `last_access_ts` - integer - Timestamp when the content was last accessed in ms. - `media_id` - string - The id used to refer to the media. Details about the format are documented under - [media repository](../media_repository.md). + [media repository](../development/internal_documentation/media_repository.md). - `media_length` - integer - Length of the media in bytes. - `media_type` - string - The MIME-type of the media. - `quarantined_by` - string - The user ID that initiated the quarantine request diff --git a/docs/code_style.md b/docs/development/code_style.md index d65fda62d1..3fb98d7cb7 100644 --- a/docs/code_style.md +++ b/docs/development/code_style.md @@ -75,7 +75,7 @@ on save as they take a while and can be very resource intensive. When adding a configuration option to the code, if several settings are grouped into a single dict, ensure that your code correctly handles the top-level option being set to `None` (as it will be if no sub-options are enabled). -The [configuration manual](usage/configuration/config_documentation.md) acts as a +The [configuration manual](../usage/configuration/config_documentation.md) acts as a reference to Synapse's configuration options for server administrators. Remember that many readers will be unfamiliar with YAML and server administration in general, so it is important that when you add diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index 1e52f9808c..91488d7f73 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -103,9 +103,9 @@ Synapse developers. regarding Synapse's Admin API, which is used mostly by sysadmins and external service developers. -Synapse's code style is documented [here](../code_style.md). Please follow +Synapse's code style is documented [here](code_style.md). Please follow it, including the conventions for the [sample configuration -file](../code_style.md#configuration-file-format). +file](code_style.md#configuration-file-format). We welcome improvements and additions to our documentation itself! When writing new pages, please diff --git a/docs/auth_chain_diff.dot b/docs/development/internal_documentation/auth_chain_diff.dot index 978d579ada..978d579ada 100644 --- a/docs/auth_chain_diff.dot +++ b/docs/development/internal_documentation/auth_chain_diff.dot diff --git a/docs/auth_chain_diff.dot.png b/docs/development/internal_documentation/auth_chain_diff.dot.png index 771c07308f..771c07308f 100644 --- a/docs/auth_chain_diff.dot.png +++ b/docs/development/internal_documentation/auth_chain_diff.dot.png Binary files differdiff --git a/docs/auth_chain_difference_algorithm.md b/docs/development/internal_documentation/auth_chain_difference_algorithm.md index ebc9de25b8..ebc9de25b8 100644 --- a/docs/auth_chain_difference_algorithm.md +++ b/docs/development/internal_documentation/auth_chain_difference_algorithm.md diff --git a/docs/development/cas.md b/docs/development/internal_documentation/cas.md index 7c0668e034..7c0668e034 100644 --- a/docs/development/cas.md +++ b/docs/development/internal_documentation/cas.md diff --git a/docs/media_repository.md b/docs/development/internal_documentation/media_repository.md index 23e6da7f31..23e6da7f31 100644 --- a/docs/media_repository.md +++ b/docs/development/internal_documentation/media_repository.md diff --git a/docs/development/room-dag-concepts.md b/docs/development/internal_documentation/room-dag-concepts.md index 76709487f8..76709487f8 100644 --- a/docs/development/room-dag-concepts.md +++ b/docs/development/internal_documentation/room-dag-concepts.md diff --git a/docs/room_and_user_statistics.md b/docs/development/internal_documentation/room_and_user_statistics.md index cc38c890bb..cc38c890bb 100644 --- a/docs/room_and_user_statistics.md +++ b/docs/development/internal_documentation/room_and_user_statistics.md diff --git a/docs/development/saml.md b/docs/development/internal_documentation/saml.md index b08bcb7419..b08bcb7419 100644 --- a/docs/development/saml.md +++ b/docs/development/internal_documentation/saml.md diff --git a/docs/opentracing.md b/docs/development/opentracing.md index abb94b565f..26e5c8b605 100644 --- a/docs/opentracing.md +++ b/docs/development/opentracing.md @@ -58,7 +58,7 @@ https://www.jaegertracing.io/docs/latest/getting-started. OpenTracing is not enabled by default. It must be enabled in the homeserver config by adding the `opentracing` option to your config file. You can find -documentation about how to do this in the [config manual under the header 'Opentracing'](usage/configuration/config_documentation.md#opentracing). +documentation about how to do this in the [config manual under the header 'Opentracing'](../usage/configuration/config_documentation.md#opentracing). See below for an example Opentracing configuration: ```yaml diff --git a/docs/log_contexts.md b/docs/development/synapse_architecture/log_contexts.md index cb15dbe158..cb15dbe158 100644 --- a/docs/log_contexts.md +++ b/docs/development/synapse_architecture/log_contexts.md diff --git a/docs/replication.md b/docs/development/synapse_architecture/replication.md index 108da9a065..108da9a065 100644 --- a/docs/replication.md +++ b/docs/development/synapse_architecture/replication.md diff --git a/docs/tcp_replication.md b/docs/development/synapse_architecture/tcp_replication.md index 15df949deb..15df949deb 100644 --- a/docs/tcp_replication.md +++ b/docs/development/synapse_architecture/tcp_replication.md diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 65025d3840..9fbc328042 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -3493,7 +3493,7 @@ user_consent: --- ### `stats` -Settings for local room and user statistics collection. See [here](../../room_and_user_statistics.md) +Settings for local room and user statistics collection. See [here](../../development/internal_documentation/room_and_user_statistics.md) for more. * `enabled`: Set to false to disable room and user statistics. Note that doing @@ -3642,7 +3642,7 @@ synapse or any other services which support opentracing Sub-options include: * `enabled`: whether tracing is enabled. Set to true to enable. Disabled by default. * `homeserver_whitelist`: The list of homeservers we wish to send and receive span contexts and span baggage. - See [here](../../opentracing.md) for more. + See [here](../../development/opentracing.md) for more. This is a list of regexes which are matched against the `server_name` of the homeserver. By default, it is empty, so no servers are matched. * `force_tracing_for_users`: # A list of the matrix IDs of users whose requests will always be traced, |
