Browse Source

Move documentation files to their place in the hierarchy; update SUMMARY.md

Andrew Morgan 2 years ago
parent
commit
1a8406f42a
35 changed files with 32 additions and 32 deletions
  1. 32 32
      docs/SUMMARY.md
  2. 0 0
      docs/development/code_style.md
  3. 0 0
      docs/development/internal_documentation/media_repository.md
  4. 0 0
      docs/development/internal_documentation/room_and_user_statistics.md
  5. 0 0
      docs/development/internal_documentation/state_resolution/auth_chain_diff.dot
  6. 0 0
      docs/development/internal_documentation/state_resolution/auth_chain_diff.dot.png
  7. 0 0
      docs/development/internal_documentation/state_resolution/auth_chain_difference_algorithm.md
  8. 0 0
      docs/development/opentracing.md
  9. 0 0
      docs/development/synapse_architecture/log_contexts.md
  10. 0 0
      docs/development/synapse_architecture/replication.md
  11. 0 0
      docs/development/synapse_architecture/tcp_replication.md
  12. 0 0
      docs/introduction/welcome_and_overview.md
  13. 0 0
      docs/other/dependency_deprecation_policy.md
  14. 0 0
      docs/setup/delegation.md
  15. 0 0
      docs/setup/postgres.md
  16. 0 0
      docs/setup/reverse_proxy.md
  17. 0 0
      docs/setup/turn-howto.md
  18. 0 0
      docs/upgrading/upgrading_from_pre_synapse_1.0.md
  19. 0 0
      docs/usage/administration/manhole.md
  20. 0 0
      docs/usage/administration/monitoring.md
  21. 0 0
      docs/usage/configuration/application_services.md
  22. 0 0
      docs/usage/configuration/consent_tracking.md
  23. 0 0
      docs/usage/configuration/json_web_tokens.md
  24. 0 0
      docs/usage/configuration/message_retention_policies.md
  25. 0 0
      docs/usage/configuration/registration_captcha.md
  26. 0 0
      docs/usage/configuration/server_notices.md
  27. 0 0
      docs/usage/configuration/structured_logging.md
  28. 0 0
      docs/usage/configuration/templates.md
  29. 0 0
      docs/usage/configuration/user_authentication/password_auth_providers.md
  30. 0 0
      docs/usage/configuration/user_authentication/single_sign_on/openid.md
  31. 0 0
      docs/usage/configuration/user_authentication/single_sign_on/sso_mapping_providers.md
  32. 0 0
      docs/usage/configuration/user_directory.md
  33. 0 0
      docs/usage/configuration/workers/README.md
  34. 0 0
      docs/usage/configuration/workers/synctl_workers.md
  35. 0 0
      docs/usage/federation/README.md

+ 32 - 32
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)

+ 0 - 0
docs/code_style.md → docs/development/code_style.md


+ 0 - 0
docs/media_repository.md → docs/development/internal_documentation/media_repository.md


+ 0 - 0
docs/room_and_user_statistics.md → docs/development/internal_documentation/room_and_user_statistics.md


+ 0 - 0
docs/auth_chain_diff.dot → docs/development/internal_documentation/state_resolution/auth_chain_diff.dot


+ 0 - 0
docs/auth_chain_diff.dot.png → docs/development/internal_documentation/state_resolution/auth_chain_diff.dot.png


+ 0 - 0
docs/auth_chain_difference_algorithm.md → docs/development/internal_documentation/state_resolution/auth_chain_difference_algorithm.md


+ 0 - 0
docs/opentracing.md → docs/development/opentracing.md


+ 0 - 0
docs/log_contexts.md → docs/development/synapse_architecture/log_contexts.md


+ 0 - 0
docs/replication.md → docs/development/synapse_architecture/replication.md


+ 0 - 0
docs/tcp_replication.md → docs/development/synapse_architecture/tcp_replication.md


+ 0 - 0
docs/welcome_and_overview.md → docs/introduction/welcome_and_overview.md


+ 0 - 0
docs/deprecation_policy.md → docs/other/dependency_deprecation_policy.md


+ 0 - 0
docs/delegate.md → docs/setup/delegation.md


+ 0 - 0
docs/postgres.md → docs/setup/postgres.md


+ 0 - 0
docs/reverse_proxy.md → docs/setup/reverse_proxy.md


+ 0 - 0
docs/turn-howto.md → docs/setup/turn-howto.md


+ 0 - 0
docs/MSC1711_certificates_FAQ.md → docs/upgrading/upgrading_from_pre_synapse_1.0.md


+ 0 - 0
docs/manhole.md → docs/usage/administration/manhole.md


+ 0 - 0
docs/metrics-howto.md → docs/usage/administration/monitoring.md


+ 0 - 0
docs/application_services.md → docs/usage/configuration/application_services.md


+ 0 - 0
docs/consent_tracking.md → docs/usage/configuration/consent_tracking.md


+ 0 - 0
docs/jwt.md → docs/usage/configuration/json_web_tokens.md


+ 0 - 0
docs/message_retention_policies.md → docs/usage/configuration/message_retention_policies.md


+ 0 - 0
docs/CAPTCHA_SETUP.md → docs/usage/configuration/registration_captcha.md


+ 0 - 0
docs/server_notices.md → docs/usage/configuration/server_notices.md


+ 0 - 0
docs/structured_logging.md → docs/usage/configuration/structured_logging.md


+ 0 - 0
docs/templates.md → docs/usage/configuration/templates.md


+ 0 - 0
docs/password_auth_providers.md → docs/usage/configuration/user_authentication/password_auth_providers.md


+ 0 - 0
docs/openid.md → docs/usage/configuration/user_authentication/single_sign_on/openid.md


+ 0 - 0
docs/sso_mapping_providers.md → docs/usage/configuration/user_authentication/single_sign_on/sso_mapping_providers.md


+ 0 - 0
docs/user_directory.md → docs/usage/configuration/user_directory.md


+ 0 - 0
docs/workers.md → docs/usage/configuration/workers/README.md


+ 0 - 0
docs/synctl_workers.md → docs/usage/configuration/workers/synctl_workers.md


+ 0 - 0
docs/federate.md → docs/usage/federation/README.md