summary refs log tree commit diff
path: root/CHANGES.md
diff options
context:
space:
mode:
authorShay <hillerys@element.io>2021-12-01 10:12:19 -0800
committerGitHub <noreply@github.com>2021-12-01 10:12:19 -0800
commit84dc50e160a2ec6590813374b5a1e58b97f7a18d (patch)
tree2376998466e330b66d147fbb65bf20a006f6b4a9 /CHANGES.md
parentAdd a license header and comment. (#11479) (diff)
downloadsynapse-84dc50e160a2ec6590813374b5a1e58b97f7a18d.tar.xz
Port wiki pages to documentation website (#11402)
* move wiki pages to synapse/docs and add a few titles where necessary

* update SUMMARY.md with added pages

* add changelog

* move incorrectly located newsfragment

* update changelog number

* snake case added files and update summary.md accordingly

* update issue/pr links

* update relative links to docs

* update changelog to indicate that we moved wiki pages to the docs and state reasoning

* revert unintentional change to CHANGES.md

* add link

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

* Update CHANGES.md

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
Diffstat (limited to 'CHANGES.md')
-rw-r--r--CHANGES.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/CHANGES.md b/CHANGES.md
index c283e33876..2e3f0da961 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1,3 +1,19 @@
+UNRELEASED
+==========
+
+We've decided to move the existing, somewhat stagnant pages from the GitHub wiki 
+to the [documentation website](https://matrix-org.github.io/synapse/latest/).
+This was done for two reasons. The first was to ensure that changes are checked by 
+multiple authors before being committed (everyone makes mistakes!) and the second
+was visibility of the documentation. Not everyone knows that Synapse has some very
+useful information hidden away in its GitHub wiki pages. Bringing them to the 
+documentation website should help with visibility, as well as keep all Synapse documentation
+in one, easily-searchable location.
+
+Note that contributions to the documentation website happen through [GitHub pull 
+requests](https://github.com/matrix-org/synapse/pulls). Please visit [#synapse-dev:matrix.org](https://matrix.to/#/#synapse-dev:matrix.org)
+if you need help with the process!
+
 Synapse 1.48.0 (2021-11-30)
 ===========================
 
@@ -86,6 +102,7 @@ Internal Changes
 - Refactor including the bundled relations when serializing an event. ([\#11408](https://github.com/matrix-org/synapse/issues/11408))
 
 
+
 Synapse 1.47.1 (2021-11-23)
 ===========================