Commit graph

1144 commits

Author SHA1 Message Date
Travis Ralston 19e94815f9 Try and improve the understanding of room versions 2019-01-17 15:13:01 -07:00
Travis Ralston 0dde2489b6 Clarify what a Mandatory room version is 2019-01-17 14:48:42 -07:00
Travis Ralston 96d754f429 promote -> prompt 2019-01-17 14:43:11 -07:00
Travis Ralston a6f5d01586 Clarify that servers don't have to implement development/beta versions 2019-01-17 14:39:06 -07:00
Travis Ralston 166d4ada86 Fix room versions reference in appendices & s2s spec 2019-01-16 17:05:57 -07:00
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.
2019-01-16 16:57:45 -07:00
Travis Ralston 258aba5fed Incorporate MSC1693
This is largely blatant copy/paste from the MSC with some formatting done to tidy it up a bit.
2019-01-07 13:09:21 -07:00
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.
2019-01-04 15:49:24 -07:00
Richard van der Hoff 958b956776
Merge pull request #1755 from matrix-org/erikj/event_checks
Document the checks made for incoming PDUs
2018-12-18 15:08:58 +01:00
Travis Ralston 35de43de61
Merge pull request #1743 from matrix-org/dbkr/add_sandbox_to_csp
Add 'sandbox' to recommended CSP header
2018-12-17 10:28:06 -07:00
Erik Johnston 39df8291e9 Add TODO 2018-12-14 13:23:18 +00:00
Erik Johnston be625254b1 Fix up wording about auth rules to not lie 2018-12-14 13:23:18 +00:00
Erik Johnston c93bdcc59c Fix up headings 2018-12-14 13:23:18 +00:00
Richard van der Hoff cac150d567
Fix up wording
Co-Authored-By: erikjohnston <erikj@jki.re>
2018-12-14 13:13:06 +00:00
Erik Johnston ee9c010c37 Document the checks made for incoming PDUs 2018-12-13 14:15:25 +00:00
Richard van der Hoff fa0b4f9e13 Make the proposal labels match what happens in practice 2018-12-13 11:14:21 +00:00
J. Ryan Stinnett d197a5761f Clarify encrypted push rules
Fix `.m.rule.encrypted_room_one_to_one` by moving a condition to the right block
of the rule.

Fix `.m.rule.encrypted` to state that it applies to group rooms.

Signed-off-by: J. Ryan Stinnett <jryans@gmail.com>
2018-12-11 16:07:01 +00:00
David Baker e318286404 Add 'sandbox' to recommended CSP header 2018-12-10 17:33:04 +00:00
Ben Parsons 16f17855c9 link to CS API Swagger Viewer 2018-12-05 15:47:55 +00:00
Ben Parsons 43109a717f placeholder for proposals CSS 2018-12-03 12:27:58 +00:00
Richard van der Hoff 767af87744
Merge pull request #1701 from uhoreg/e2e_export
document megolm session export format
2018-11-06 11:58:00 +00:00
Hubert Chathi 189725659a clarifications and formatting fixes 2018-11-05 15:43:18 -05:00
Matthew Hodgson 179162379e spell out that shepherd cannot be author 2018-10-27 19:34:52 +01:00
Erik Johnston 4271391214
Initial stab at documenting soft fail (#1641) 2018-10-26 15:18:04 +01:00
Andrew Morgan f288facec8
Merge pull request #1697 from matrix-org/anoa/msc_update
The new and improved MSC process
2018-10-23 20:02:36 +02:00
Andrew Morgan f8ffa79b56 Update and clarify proposal labels 2018-10-23 19:37:51 +02:00
Andrew Morgan 2b259c6a7b Remove etiquette page from targets 2018-10-21 00:54:04 +02:00
Andrew Morgan 4b858a7993 DCO required for proposal and spec PR 2018-10-21 00:52:39 +02:00
Andrew Morgan 0afb122760 Clarification on FCPs 2018-10-20 23:50:26 +02:00
Andrew Morgan f00be6b0d8 Etiquette -> guiding principles 2018-10-20 23:35:33 +02:00
Hubert Chathi 46fde9723c document megolm session export format 2018-10-19 10:55:14 -04:00
Matthew Hodgson c6e0a88b09 fix irc bridge example properly 2018-10-18 21:50:39 +01:00
Matthew Hodgson 7a86bc4a66 fix missing escapes on AS regexp 2018-10-18 21:48:14 +01:00
Andrew Morgan ea21e31a0c Merge branch 'anoa/msc_update' of github.com:matrix-org/matrix-doc into anoa/msc_update 2018-10-18 16:03:14 +02:00
Andrew Morgan 7bff4d288c be begin -> begin 2018-10-18 15:52:28 +02:00
Travis Ralston 5a2d28e7fd Reduce more abbreviations! 2018-10-17 18:21:16 +02:00
Travis Ralston 9625f11fd4 reduce abbreviations 2018-10-17 18:20:42 +02:00
Andrew Morgan d487c0974f Clarify how to get a shepherd (just ask) 2018-10-17 17:17:07 +02:00
Andrew Morgan 45c935d8d3 Clarify that MSCs aren't just issues anymore. 2018-10-17 15:35:15 +02:00
Andrew Morgan 1e939c50f5 Gather feedback 2018-10-17 14:49:01 +02:00
Andrew Morgan 148f7d7b33 Minor proposal updates are allowed 2018-10-17 14:34:57 +02:00
Andrew Morgan 5a1e735921 Fix sign off bullet 2018-10-16 01:21:14 +02:00
Andrew Morgan aeea060bb8 Specify where to find the MSC ID 2018-10-16 01:06:44 +02:00
Andrew Morgan 7753957d04 remove ambiguity 2018-10-16 01:04:54 +02:00
Andrew Morgan 2f0025c7a7 Fix up wording in proposal etiquette 2018-10-16 00:57:11 +02:00
Andrew Morgan 35c924308c core team -> Core Team 2018-10-16 00:57:08 +02:00
Andrew Morgan 8121bef771 Introduce the spec core team 2018-10-16 00:44:05 +02:00
Andrew Morgan c1ecb9e324 Fix up table with title and add corresponding GitHub labels 2018-10-16 00:17:08 +02:00
Andrew Morgan 889b46898c Move proposal etiquette to a separate document. 2018-10-16 00:07:16 +02:00
Andrew Morgan 49d017bdd5 your proposal -> the proposal 2018-10-15 23:51:28 +02:00