Commit Graph

26 Commits (19e94815f9bc65bacca00e9c3c078d983a941b91)

Author SHA1 Message Date
Travis Ralston 71e6321f4d Rework how room versions are represented
Versions are actually on a scale of recommendations, and are expected to be created as needed. The scale presented here (develop/beta/default/recommended/mandatory) is a more wordy version of what was previously discussed/intended for room versions - the labels aren't final and may be changed.
6 years ago
Travis Ralston ffe577371d Add a room version specification
The "Room Specification" (or "Room Version Specification") is the specification that defines which room versions do what and are intended to be documents which speak the truth about how rooms operate under the hood.

The approach taken here is a bit different than other specifications. For starters, the specification is versioned in this project instead of relying on the matrix.org repository to track compiled HTML. This is done for a couple reasons, the first being we're still developing the v1 specification while concurrently making a v2 spec and the second being trying to reduce the reliance on matrix.org's repository for specifications.

Because the room spec is built into versions, some changes needed to be made. The `targets.yaml` now has a special syntax for indicating what version something is at, and the changelog generator can handle rendering different versions of the same changelog (as parsed from the RST). Some additional work has been put in to the changelog parsing to allow us to reference the v1 room spec as "v1" without having to sacrifice clarity in the changelog headings.

Finally, this moves the state resolution algorithms into the versioned
spec as a result of MSC1759 (https://github.com/matrix-org/matrix-doc/pull/1759).

Note: this does not introduce the concept of versioned schemas (tabs) that I was previously working with. There's currently no use for them, so they are shelved elsewhere.
6 years ago
Travis Ralston 7d34995ece It's actually an "identity server implementing the Identity Service API"
Also add a note about appservices being special.
6 years ago
Travis Ralston c94f3619b7 Missed a rogue case of identity server 6 years ago
Travis Ralston 7ac76fa27c Actually we're going with "identity server" afterall 6 years ago
Travis Ralston ec248b436f Identity Service is lowercase 6 years ago
Travis Ralston cc0badaaa1 Fix all naming cases of "identity service"
Fixes https://github.com/matrix-org/matrix-doc/issues/1396

Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
6 years ago
Travis Ralston 138419cdd4
fix indentation on release process doc 6 years ago
Travis Ralston 2ab2f91088 Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0 6 years ago
Travis Ralston e141f61df3 Update release instructions to reference symlinks, what files to update, etc 6 years ago
Travis Ralston 5b73a0174d Clarify what the release branch is used for, and how it should be named 6 years ago
Richard van der Hoff c2ed79bd1a
Sentence case for headings 6 years ago
Travis Ralston ba51d5960e r0.1.0 release of the Push Gateway specification
Because this is the first release, it has several moving parts to it:
* The version variables have been defined.
* The towncrier changelog has been prepared for future modifications.
* The templating has been updated to better support future versions of the specification.
* A release process document has been created.
6 years ago
Richard van der Hoff 2605c75f92
typo 6 years ago
Richard van der Hoff c84066df89
do not use 'optional' in descriptions. 6 years ago
Richard van der Hoff dfa4af5c19
record that "identity server" has two words 6 years ago
Richard van der Hoff 3c7db643c3
Update documentation_style.rst
spell homeserver
6 years ago
Richard van der Hoff 196e668768
Update documentation_style.rst 6 years ago
Richard van der Hoff 0a917b2c70
documentation_style typo 6 years ago
Richard van der Hoff 1028ea3558
doc style: lists 6 years ago
Richard van der Hoff 3c40d5a94e
documentation_style: fix indentation 6 years ago
Richard van der Hoff 306783b7bf notes on doc style 6 years ago
Richard van der Hoff 91c1d9ed58
documentation_style.rst: Fix rst syntax
apparently the rst parser gets confused by '- `````'.
6 years ago
Richard van der Hoff b5d68b8ff1 Link to doc style doc
(and update it to cover extra section characters)
8 years ago
Kegsay 4fd5b9ced8 Update doc style
We use RST everywhere, which dictates most of the style, so the styles mentioned previously were either obsolete or inaccurate. Updated the doc to be clearer on things which RST does not specify/care about.
10 years ago
Matthew Hodgson 556e3f8a71 move matrix-generic documentation from synapse/docs into new matrix-doc project 10 years ago