diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2020-02-14 16:22:30 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-14 16:22:30 +0000 |
| commit | 97a42bbc3a4789620c48746f8e87291446f6f5ac (patch) | |
| tree | 486b0a1f4aee4d3e0acffcc00ee25ad7cea17ced /docs | |
| parent | Convert the directory handler tests to use HomeserverTestCase (#6919) (diff) | |
| download | synapse-97a42bbc3a4789620c48746f8e87291446f6f5ac.tar.xz | |
Add a warning about indentation to generated config (#6920)
Fixes #6916.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/.sample_config_header.yaml | 4 | ||||
| -rw-r--r-- | docs/sample_config.yaml | 12 |
2 files changed, 14 insertions, 2 deletions
diff --git a/docs/.sample_config_header.yaml b/docs/.sample_config_header.yaml index e001ef5983..35a591d042 100644 --- a/docs/.sample_config_header.yaml +++ b/docs/.sample_config_header.yaml @@ -1,4 +1,4 @@ -# The config is maintained as an up-to-date snapshot of the default +# This file is maintained as an up-to-date snapshot of the default # homeserver.yaml configuration generated by Synapse. # # It is intended to act as a reference for the default configuration, @@ -10,3 +10,5 @@ # homeserver.yaml. Instead, if you are starting from scratch, please generate # a fresh config using Synapse by following the instructions in INSTALL.md. +################################################################################ + diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 8e8cf513b0..93236daddc 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -1,4 +1,4 @@ -# The config is maintained as an up-to-date snapshot of the default +# This file is maintained as an up-to-date snapshot of the default # homeserver.yaml configuration generated by Synapse. # # It is intended to act as a reference for the default configuration, @@ -10,6 +10,16 @@ # homeserver.yaml. Instead, if you are starting from scratch, please generate # a fresh config using Synapse by following the instructions in INSTALL.md. +################################################################################ + +# Configuration file for Synapse. +# +# This is a YAML file: see [1] for a quick introduction. Note in particular +# that *indentation is important*: all the elements of a list or dictionary +# should have the same indentation. +# +# [1] https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html + ## Server ## # The domain name of the server, with optional explicit port. |