docs-matrix-spec/changelogs
Travis Ralston 9af83dfd41
Add Spaces to the spec (#3610)
* First iteration of specifying Spaces

MSCs:
* https://github.com/matrix-org/matrix-doc/pull/3288
* https://github.com/matrix-org/matrix-doc/pull/2946
* https://github.com/matrix-org/matrix-doc/pull/1772

Note that this makes modifications to the underlying MSCs as well. These are intended to be minor edits to aid clarity/accuracy of the MSCs, as per the proposal process. Functionally, clients and servers might need to change their behaviour slightly as is expected of implementing this stuff early. Synapse has these changes (alongside backwards compatibility) here: https://github.com/matrix-org/synapse/pull/11667

* add changelogs

* Accuracy per review

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* fully prefix new endpoints

* Fully prefix endpoint in 3616 too

* Fix ordering example

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2022-01-17 10:03:14 -07:00
..
appendices/newsfragments Add a changelog for the appendices (#3609) 2022-01-04 20:23:02 -07:00
application_service/newsfragments v1.1 changelog 2021-11-09 07:23:27 -07:00
client_server/newsfragments Add Spaces to the spec (#3610) 2022-01-17 10:03:14 -07:00
identity_service/newsfragments Add Spaces to the spec (#3610) 2022-01-17 10:03:14 -07:00
legacy Add GitHub Action to check spelling (#3591) 2021-12-28 09:17:49 -07:00
push_gateway/newsfragments v1.1 changelog 2021-11-09 07:23:27 -07:00
room_versions/newsfragments Remove C-S unsigned data from PDU definitions (#3522) 2021-11-24 12:31:14 +00:00
server_server/newsfragments Add Spaces to the spec (#3610) 2022-01-17 10:03:14 -07:00
header.md Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
pyproject.toml Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
README.md Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00

Changelogs

Towncrier is used to manage the changelog and keep it up to date. Because of this, updating a changelog is really easy.

Generating the changelog

Please see the release docs for more information.

Creating a new changelog

There are a few places you'll have to update:

  • /layouts/shortcodes/changelog/changelog-changes.html to account for the new changelog.
  • /scripts/generate-changelog.sh to render the changelog for releases.
  • Supporting documentation such as the contributing guidelines.