Include a default configuration file in the 'docs' directory. (#4791)

matrix-org · Mar 4, 2019 · 8e28bc5 · 8e28bc5
1 parent aba5eea
commit 8e28bc5
Show file tree

Hide file tree

Showing 11 changed files with 1,114 additions and 13 deletions.
diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
@@ -38,6 +38,14 @@ steps:
 
   - wait
 
+  - command:
+      - "python -m pip install tox"
+      - "tox -e check-sampleconfig"
+    label: "\U0001F9F9 check-sample-config"
+    plugins:
+      - docker#v3.0.1:
+          image: "python:3.6"
+
   - command:
       - "python -m pip install tox"
       - "tox -e py27,codecov"

diff --git a/changelog.d/4791.feature b/changelog.d/4791.feature
@@ -0,0 +1 @@
+Include a default configuration file in the 'docs' directory.
diff --git a/docs/.sample_config_header.yaml b/docs/.sample_config_header.yaml
@@ -0,0 +1,7 @@
+# This file is a reference to the configuration options which can be set in
+# homeserver.yaml.
+#
+# Note that it is not quite ready to be used as-is. If you are starting from
+# scratch, it is easier to generate the config files following the instructions
+# in INSTALL.md.
+