diff options
author | Andrew Morgan <andrew@amorgan.xyz> | 2021-11-21 02:39:02 +0000 |
---|---|---|
committer | Andrew Morgan <andrew@amorgan.xyz> | 2021-11-21 02:39:02 +0000 |
commit | 1a8406f42ac3a7f63690c13cb8d8fd5547928632 (patch) | |
tree | b87d0c0ca33f6f2eea33cf953aef9767183c702f | |
parent | Update README.md (diff) | |
download | synapse-1a8406f42ac3a7f63690c13cb8d8fd5547928632.tar.xz |
Move documentation files to their place in the hierarchy; update SUMMARY.md github/anoa/doc_hierarchy anoa/doc_hierarchy
-rw-r--r-- | docs/SUMMARY.md | 64 | ||||
-rw-r--r-- | docs/development/code_style.md (renamed from docs/code_style.md) | 0 | ||||
-rw-r--r-- | docs/development/internal_documentation/media_repository.md (renamed from docs/media_repository.md) | 0 | ||||
-rw-r--r-- | docs/development/internal_documentation/room_and_user_statistics.md (renamed from docs/room_and_user_statistics.md) | 0 | ||||
-rw-r--r-- | docs/development/internal_documentation/state_resolution/auth_chain_diff.dot (renamed from docs/auth_chain_diff.dot) | 0 | ||||
-rw-r--r-- | docs/development/internal_documentation/state_resolution/auth_chain_diff.dot.png (renamed from docs/auth_chain_diff.dot.png) | bin | 42427 -> 42427 bytes | |||
-rw-r--r-- | docs/development/internal_documentation/state_resolution/auth_chain_difference_algorithm.md (renamed from docs/auth_chain_difference_algorithm.md) | 0 | ||||
-rw-r--r-- | docs/development/opentracing.md (renamed from docs/opentracing.md) | 0 | ||||
-rw-r--r-- | docs/development/synapse_architecture/log_contexts.md (renamed from docs/log_contexts.md) | 0 | ||||
-rw-r--r-- | docs/development/synapse_architecture/replication.md (renamed from docs/replication.md) | 0 | ||||
-rw-r--r-- | docs/development/synapse_architecture/tcp_replication.md (renamed from docs/tcp_replication.md) | 0 | ||||
-rw-r--r-- | docs/introduction/welcome_and_overview.md (renamed from docs/welcome_and_overview.md) | 0 | ||||
-rw-r--r-- | docs/other/dependency_deprecation_policy.md (renamed from docs/deprecation_policy.md) | 0 | ||||
-rw-r--r-- | docs/setup/delegation.md (renamed from docs/delegate.md) | 0 | ||||
-rw-r--r-- | docs/setup/postgres.md (renamed from docs/postgres.md) | 0 | ||||
-rw-r--r-- | docs/setup/reverse_proxy.md (renamed from docs/reverse_proxy.md) | 0 | ||||
-rw-r--r-- | docs/setup/turn-howto.md (renamed from docs/turn-howto.md) | 0 | ||||
-rw-r--r-- | docs/upgrading/upgrading_from_pre_synapse_1.0.md (renamed from docs/MSC1711_certificates_FAQ.md) | 0 | ||||
-rw-r--r-- | docs/usage/administration/manhole.md (renamed from docs/manhole.md) | 0 | ||||
-rw-r--r-- | docs/usage/administration/monitoring.md (renamed from docs/metrics-howto.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/application_services.md (renamed from docs/application_services.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/consent_tracking.md (renamed from docs/consent_tracking.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/json_web_tokens.md (renamed from docs/jwt.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/message_retention_policies.md (renamed from docs/message_retention_policies.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/registration_captcha.md (renamed from docs/CAPTCHA_SETUP.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/server_notices.md (renamed from docs/server_notices.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/structured_logging.md (renamed from docs/structured_logging.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/templates.md (renamed from docs/templates.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/user_authentication/password_auth_providers.md (renamed from docs/password_auth_providers.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/user_authentication/single_sign_on/openid.md (renamed from docs/openid.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/user_authentication/single_sign_on/sso_mapping_providers.md (renamed from docs/sso_mapping_providers.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/user_directory.md (renamed from docs/user_directory.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/workers/README.md (renamed from docs/workers.md) | 0 | ||||
-rw-r--r-- | docs/usage/configuration/workers/synctl_workers.md (renamed from docs/synctl_workers.md) | 0 | ||||
-rw-r--r-- | docs/usage/federation/README.md (renamed from docs/federate.md) | 0 |
35 files changed, 32 insertions, 32 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index cdedf8bccc..9af7d006c0 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,42 +1,42 @@ # Summary # Introduction -- [Welcome and Overview](welcome_and_overview.md) +- [Welcome and Overview](introduction/welcome_and_overview.md) # Setup - [Installation](setup/installation.md) - - [Using Postgres](postgres.md) - - [Configuring a Reverse Proxy](reverse_proxy.md) + - [Using Postgres](setup/postgres.md) + - [Configuring a Reverse Proxy](setup/reverse_proxy.md) - [Configuring a Forward/Outbound Proxy](setup/forward_proxy.md) - - [Configuring a Turn Server](turn-howto.md) - - [Delegation](delegate.md) + - [Configuring a Turn Server](setup/turn-howto.md) + - [Delegation](setup/delegation.md) # Upgrading - [Upgrading between Synapse Versions](upgrade.md) - - [Upgrading from pre-Synapse 1.0](MSC1711_certificates_FAQ.md) + - [Upgrading from pre-Synapse 1.0](upgrading/upgrading_from_pre_synapse_1.0.md) # Usage - - [Federation](federate.md) + - [Federation](usage/federation/README.md) - [Configuration](usage/configuration/README.md) - [Homeserver Sample Config File](usage/configuration/homeserver_sample_config.md) - [Logging Sample Config File](usage/configuration/logging_sample_config.md) - - [Structured Logging](structured_logging.md) - - [Templates](templates.md) + - [Structured Logging](usage/configuration/structured_logging.md) + - [Templates](usage/configuration/templates.md) - [User Authentication](usage/configuration/user_authentication/README.md) - [Single-Sign On](usage/configuration/user_authentication/single_sign_on/README.md) - - [OpenID Connect](openid.md) + - [OpenID Connect](usage/configuration/user_authentication/single_sign_on/openid.md) - [SAML](usage/configuration/user_authentication/single_sign_on/saml.md) - [CAS](usage/configuration/user_authentication/single_sign_on/cas.md) - - [SSO Mapping Providers](sso_mapping_providers.md) - - [Password Auth Providers](password_auth_providers.md) - - [JSON Web Tokens](jwt.md) - - [Registration Captcha](CAPTCHA_SETUP.md) - - [Application Services](application_services.md) - - [Server Notices](server_notices.md) - - [Consent Tracking](consent_tracking.md) + - [SSO Mapping Providers](usage/configuration/user_authentication/single_sign_on/sso_mapping_providers.md) + - [Password Auth Providers](usage/configuration/user_authentication/password_auth_providers.md) + - [JSON Web Tokens](usage/configuration/json_web_tokens.md) + - [Registration Captcha](usage/configuration/registration_captcha.md) + - [Application Services](usage/configuration/application_services.md) + - [Server Notices](usage/configuration/server_notices.md) + - [Consent Tracking](usage/configuration/consent_tracking.md) - [URL Previews](development/url_previews.md) - - [User Directory](user_directory.md) - - [Message Retention Policies](message_retention_policies.md) + - [User Directory](usage/configuration/user_directory.md) + - [Message Retention Policies](usage/configuration/message_retention_policies.md) - [Pluggable Modules](modules/index.md) - [Writing a module](modules/writing_a_module.md) - [Spam checker callbacks](modules/spam_checker_callbacks.md) @@ -45,8 +45,8 @@ - [Account validity callbacks](modules/account_validity_callbacks.md) - [Password auth provider callbacks](modules/password_auth_provider_callbacks.md) - [Porting a legacy module to the new interface](modules/porting_legacy_module.md) - - [Workers](workers.md) - - [Using `synctl` with Workers](synctl_workers.md) + - [Workers](usage/configuration/workers/README.md) + - [Using `synctl` with Workers](usage/configuration/workers/synctl_workers.md) - [Systemd](systemd-with-workers/README.md) - [Administration](usage/administration/README.md) - [Admin API](usage/administration/admin_api/README.md) @@ -64,33 +64,33 @@ - [Statistics](admin_api/statistics.md) - [Users](admin_api/user_admin_api.md) - [Server Version](admin_api/version_api.md) - - [Manhole](manhole.md) - - [Monitoring](metrics-howto.md) + - [Manhole](usage/administration/manhole.md) + - [Monitoring](usage/administration/monitoring.md) - [Request log format](usage/administration/request_log.md) - [Scripts]() # Development - [Contributing Guide](development/contributing_guide.md) - - [Code Style](code_style.md) + - [Code Style](development/code_style.md) - [Git Usage](development/git.md) - [Testing]() - - [OpenTracing](opentracing.md) + - [OpenTracing](development/opentracing.md) - [Database Schemas](development/database_schema.md) - [Experimental features](development/experimental_features.md) - [Synapse Architecture]() - - [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) - [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/state_resolution/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 - - [Dependency Deprecation Policy](deprecation_policy.md) + - [Dependency Deprecation Policy](other/dependency_deprecation_policy.md) diff --git a/docs/code_style.md b/docs/development/code_style.md index 4d8e7c973d..4d8e7c973d 100644 --- a/docs/code_style.md +++ b/docs/development/code_style.md diff --git a/docs/media_repository.md b/docs/development/internal_documentation/media_repository.md index 99ee8f1ef7..99ee8f1ef7 100644 --- a/docs/media_repository.md +++ b/docs/development/internal_documentation/media_repository.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/auth_chain_diff.dot b/docs/development/internal_documentation/state_resolution/auth_chain_diff.dot index 978d579ada..978d579ada 100644 --- a/docs/auth_chain_diff.dot +++ b/docs/development/internal_documentation/state_resolution/auth_chain_diff.dot diff --git a/docs/auth_chain_diff.dot.png b/docs/development/internal_documentation/state_resolution/auth_chain_diff.dot.png index 771c07308f..771c07308f 100644 --- a/docs/auth_chain_diff.dot.png +++ b/docs/development/internal_documentation/state_resolution/auth_chain_diff.dot.png Binary files differdiff --git a/docs/auth_chain_difference_algorithm.md b/docs/development/internal_documentation/state_resolution/auth_chain_difference_algorithm.md index 30f72a70da..30f72a70da 100644 --- a/docs/auth_chain_difference_algorithm.md +++ b/docs/development/internal_documentation/state_resolution/auth_chain_difference_algorithm.md diff --git a/docs/opentracing.md b/docs/development/opentracing.md index f91362f112..f91362f112 100644 --- a/docs/opentracing.md +++ b/docs/development/opentracing.md 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 e82df0de8a..e82df0de8a 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/welcome_and_overview.md b/docs/introduction/welcome_and_overview.md index aab2d6b4f0..aab2d6b4f0 100644 --- a/docs/welcome_and_overview.md +++ b/docs/introduction/welcome_and_overview.md diff --git a/docs/deprecation_policy.md b/docs/other/dependency_deprecation_policy.md index 06ea340559..06ea340559 100644 --- a/docs/deprecation_policy.md +++ b/docs/other/dependency_deprecation_policy.md diff --git a/docs/delegate.md b/docs/setup/delegation.md index ee9cbb3b1c..ee9cbb3b1c 100644 --- a/docs/delegate.md +++ b/docs/setup/delegation.md diff --git a/docs/postgres.md b/docs/setup/postgres.md index 083b0aaff0..083b0aaff0 100644 --- a/docs/postgres.md +++ b/docs/setup/postgres.md diff --git a/docs/reverse_proxy.md b/docs/setup/reverse_proxy.md index f3b3aea732..f3b3aea732 100644 --- a/docs/reverse_proxy.md +++ b/docs/setup/reverse_proxy.md diff --git a/docs/turn-howto.md b/docs/setup/turn-howto.md index e6812de69e..e6812de69e 100644 --- a/docs/turn-howto.md +++ b/docs/setup/turn-howto.md diff --git a/docs/MSC1711_certificates_FAQ.md b/docs/upgrading/upgrading_from_pre_synapse_1.0.md index 086899a9d8..086899a9d8 100644 --- a/docs/MSC1711_certificates_FAQ.md +++ b/docs/upgrading/upgrading_from_pre_synapse_1.0.md diff --git a/docs/manhole.md b/docs/usage/administration/manhole.md index 715ed840f2..715ed840f2 100644 --- a/docs/manhole.md +++ b/docs/usage/administration/manhole.md diff --git a/docs/metrics-howto.md b/docs/usage/administration/monitoring.md index 4a77d5604c..4a77d5604c 100644 --- a/docs/metrics-howto.md +++ b/docs/usage/administration/monitoring.md diff --git a/docs/application_services.md b/docs/usage/configuration/application_services.md index e4592010a2..e4592010a2 100644 --- a/docs/application_services.md +++ b/docs/usage/configuration/application_services.md diff --git a/docs/consent_tracking.md b/docs/usage/configuration/consent_tracking.md index fb1fec80fe..fb1fec80fe 100644 --- a/docs/consent_tracking.md +++ b/docs/usage/configuration/consent_tracking.md diff --git a/docs/jwt.md b/docs/usage/configuration/json_web_tokens.md index 5be9fd26e3..5be9fd26e3 100644 --- a/docs/jwt.md +++ b/docs/usage/configuration/json_web_tokens.md diff --git a/docs/message_retention_policies.md b/docs/usage/configuration/message_retention_policies.md index 9214d6d7e9..9214d6d7e9 100644 --- a/docs/message_retention_policies.md +++ b/docs/usage/configuration/message_retention_policies.md diff --git a/docs/CAPTCHA_SETUP.md b/docs/usage/configuration/registration_captcha.md index 49419ce8df..49419ce8df 100644 --- a/docs/CAPTCHA_SETUP.md +++ b/docs/usage/configuration/registration_captcha.md diff --git a/docs/server_notices.md b/docs/usage/configuration/server_notices.md index 339d10a0ab..339d10a0ab 100644 --- a/docs/server_notices.md +++ b/docs/usage/configuration/server_notices.md diff --git a/docs/structured_logging.md b/docs/usage/configuration/structured_logging.md index b1281667e0..b1281667e0 100644 --- a/docs/structured_logging.md +++ b/docs/usage/configuration/structured_logging.md diff --git a/docs/templates.md b/docs/usage/configuration/templates.md index a240f58b54..a240f58b54 100644 --- a/docs/templates.md +++ b/docs/usage/configuration/templates.md diff --git a/docs/password_auth_providers.md b/docs/usage/configuration/user_authentication/password_auth_providers.md index dc0dfffa21..dc0dfffa21 100644 --- a/docs/password_auth_providers.md +++ b/docs/usage/configuration/user_authentication/password_auth_providers.md diff --git a/docs/openid.md b/docs/usage/configuration/user_authentication/single_sign_on/openid.md index c74e8bda60..c74e8bda60 100644 --- a/docs/openid.md +++ b/docs/usage/configuration/user_authentication/single_sign_on/openid.md diff --git a/docs/sso_mapping_providers.md b/docs/usage/configuration/user_authentication/single_sign_on/sso_mapping_providers.md index 7a407012e0..7a407012e0 100644 --- a/docs/sso_mapping_providers.md +++ b/docs/usage/configuration/user_authentication/single_sign_on/sso_mapping_providers.md diff --git a/docs/user_directory.md b/docs/usage/configuration/user_directory.md index c4794b04cf..c4794b04cf 100644 --- a/docs/user_directory.md +++ b/docs/usage/configuration/user_directory.md diff --git a/docs/workers.md b/docs/usage/configuration/workers/README.md index 17c8bfeef6..17c8bfeef6 100644 --- a/docs/workers.md +++ b/docs/usage/configuration/workers/README.md diff --git a/docs/synctl_workers.md b/docs/usage/configuration/workers/synctl_workers.md index 15e37f608d..15e37f608d 100644 --- a/docs/synctl_workers.md +++ b/docs/usage/configuration/workers/synctl_workers.md diff --git a/docs/federate.md b/docs/usage/federation/README.md index 5107f995be..5107f995be 100644 --- a/docs/federate.md +++ b/docs/usage/federation/README.md |