wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
6888 commits 4 branches 0 tags 17 MiB
Commit graph

399 commits

Author SHA1 Message Date
Richard van der Hoff
8773b9319b
Merge pull request #1599 from matrix-org/benpa/spec-tables-prettier 
Benpa/spec tables prettier
 2018-08-31 21:40:55 +01:00
Travis Ralston
84a2b7f3c0
Merge pull request #1632 from uhoreg/fix_room_member_state_key 
fix handling of multi-line state key descriptions
 2018-08-31 14:38:58 -06:00
Ben Parsons
c77b505441 capitali[zs]e path parameters 2018-08-31 14:37:47 +01:00
Ben Parsons
778fe2a47a css caption size tweak 2018-08-31 14:29:46 +01:00
Ben Parsons
e8afab1fe5 many visual improvements 2018-08-31 13:55:27 +01:00
Travis Ralston
98a445890c Render a warning if the spec is unstable 
Fixes https://github.com/matrix-org/matrix-doc/issues/1499

This is done by using magic variables in the RST. The magic variables are generated based on the substitutions available, making them available for use at build-time. 

Magic variables were chosen because it allows people to continue working on the spec and release process without having to worry about removing a chunk of text from the top of the file. Originally, this was attempted by using jinja2 if-statements, however the substitutions are replaced *after* the template is executed, so the condition would never match. 

The format of the variable is to make the templating happy. Using colons or percent signs results in the templator thinking something else is going on, and then complaining about format.
 2018-08-30 15:05:50 -06:00
Travis Ralston
cee0a5ac7b
Merge pull request #1557 from turt2live/travis/general/r0-prep 
Prepare the identity service and server-server APIs for r0
 2018-08-30 14:46:35 -06:00
Hubert Chathi
a1b1054aa1 fix handling of multi-line state key descriptions 2018-08-30 15:57:09 -04:00
Travis Ralston
2753d24302 Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep 2018-08-30 12:17:09 -06:00
Travis Ralston
827033c128 Merge remote matrix-org/master 2018-08-30 11:29:47 -06:00
Richard van der Hoff
f649d04ae1
Merge pull request #1626 from matrix-org/rav/encoding 
Set the encoding to UTF-8 on all file I/O
 2018-08-30 18:11:38 +01:00
Richard van der Hoff
20c9829f56
Merge pull request #1627 from matrix-org/travis/general/dont-build-proposals 
Don't generate proposals.rst in Circle CI
 2018-08-30 18:10:48 +01:00
Travis Ralston
ecd3ce39e5 Don't generate proposals.rst in Circle CI 2018-08-30 10:38:23 -06:00
Richard van der Hoff
4e90b32348 Set the encoding to UTF-8 on all file I/O 
Hopefully this will resolve issues with building the spec on systems where the
default encoding is somthing other than UTF-8.
 2018-08-30 17:18:07 +01:00
Ben Parsons
f1ae872857 light zebra striping for tables 2018-08-30 17:16:45 +01:00
Ben Parsons
9e1d6d7490 sanitise caption handling 2018-08-30 17:01:27 +01:00
Travis Ralston
b2092922e8 Don't define a variable for the appservice major version 2018-08-29 21:51:26 -06:00
Travis Ralston
a5c3924492 Merge remote matrix-org/master 2018-08-29 21:28:24 -06:00
Travis Ralston
c7a228bf7b Don't make the major version a variable 
We are likely to want to maintain v1 when we release a v2, so we'll avoid a variable for now.
 2018-08-29 19:32:52 -06:00
Travis Ralston
e7a69a6a6d Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep 2018-08-29 19:29:42 -06:00
Travis Ralston
2ab2f91088 Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0 2018-08-29 17:54:34 -06:00
Ben Parsons
380a53ecba adjust caption -> smaller, left align 2018-08-29 17:18:37 +01:00
Ben Parsons
989b50a1a0 remove debug string 2018-08-29 16:40:26 +01:00
Ben Parsons
6e0fe70500 make spec tables prettier 2018-08-29 16:38:59 +01:00
Travis Ralston
b402608b41 Don't reference the major version for the push gateway specification 
If we ever have a v2 endpoint for the push gateway, we'd likely spec it alongside the v1 stuff, updating applicable references elsewhere.
 2018-08-28 14:40:14 -06:00
Travis Ralston
4278a9a516 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/fix-events 2018-08-27 19:17:37 -06:00
Travis Ralston
fa96d8629b Prepare the appservice spec for an r0 release 
This puts the scaffolding in place for an r0 release to happen, such as the changelog and version variables.
 2018-08-27 18:04:08 -06:00
Travis Ralston
e9e93b0eec Move invite_room_state to the correct place in the client-server API 
Fixes https://github.com/matrix-org/matrix-doc/issues/1350
 2018-08-26 20:51:39 -06:00
Travis Ralston
0f28f83270 Fix client-server event schemas: remove age, dedupe fields 
This commit adds support for event schema examples to have references to help reduce the chance of fields being forgotten. This also helps reduce duplication of fields, allowing for a more consistent spec that uses the same values everywhere.

This also removes both `unsigned` and `age` from the examples as per:
* https://github.com/matrix-org/matrix-doc/issues/1524
* https://github.com/matrix-org/matrix-doc/issues/630

Finally, this replaces "localhost" in the examples with an example domain. This is really just a nitpick thing on my part where seeing a "real world" domain is preferred. 

Fixes https://github.com/matrix-org/matrix-doc/issues/1524
Fixes https://github.com/matrix-org/matrix-doc/issues/630
Step towards https://github.com/matrix-org/matrix-doc/issues/1530
 2018-08-24 18:04:51 -06:00
Travis Ralston
d370a2c6fd Prepare the identity service and server-server APIs for r0 
* Create the changelog scaffolding
* Set up the variables for versioning
 2018-08-24 17:19:25 -06:00
Travis Ralston
750d4f9fda Rename the presence EDU files to be accurate to their types; Misc cleanup of titles 2018-08-17 10:53:47 -06:00
Travis Ralston
a53fa9300d Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence 2018-08-17 09:34:16 -06:00
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.
 2018-08-16 11:50:18 -06:00
Kitsune Ral
9be78f3aa7 Better support enums when they come among oneOf types 2018-08-12 16:45:35 +09:00
Kitsune Ral
88d97b06ae Support oneOf 2018-08-12 16:45:33 +09:00
Travis Ralston
05a2427c73 Document how presence EDUs work between servers 
It's worth noting that Synapse does not make use of the `poll` or `unpoll` fields, and therefore the wording has been updated to permit servers to reject users. In the case of synapse, it would automatically reject everyone in the list by nature of ignoring it.
 2018-08-08 08:24:09 -06:00
Travis Ralston
0f8954d839
Merge pull request #1463 from turt2live/travis/s2s/pdus-and-edus 
Improve documentation around EDUs and PDUs
 2018-08-08 08:02:37 -06:00
Travis Ralston
db6d466fa1 Go one level deep when finding definitions 
This is useful for when we start defining event schemas. This also has a sanity check for ensuring the directory exists, allowing the IS and push API paths to be uncommented.
 2018-08-03 19:49:46 -06:00
Travis Ralston
96f5510266 Ensure the example is always set to something 2018-08-03 12:03:23 -06:00
Travis Ralston
ea307b5bdb Support rendering schema definitions in the spec 2018-07-31 13:55:53 -06:00
Ben Parsons
1d019c3757
Merge pull request #1340 from matrix-org/benparsons/prdefence 
expect "#<pull-number>" or "/pull/<pull-number>" in PRs field
 2018-07-31 15:17:42 +01:00
Ben Parsons
d7919b6989 also scrape PRs when the full URL is pasted 2018-07-31 15:08:42 +01:00
Travis Ralston
bc3e45d642
Merge pull request #1358 from uhoreg/ignore-emacs-tmp 
ignore emacs temporary files
 2018-07-30 17:09:08 -06:00
Travis Ralston
4f24d2101f Only get issues that are proposals when finding proposals 
Otherwise we end up with not-proposals showing up in the list.
 2018-07-26 09:51:08 -06:00
Travis Ralston
dcc4b0bfbc Remove Travis CI configuration 
We're using Circle CI for testing a bunch of the spec, and so far it has the advantage of being faster. Also, it's not named the same as me.

We can also remove the Travis CI specific check in generate-matrix-org-assets because Circle CI doesn't touch this.
 2018-07-24 14:47:47 -06:00
Travis Ralston
acf9632afc Enlist the examples 2018-07-24 10:25:24 -06:00
Travis Ralston
9fa838d3e8 Improve type naming 2018-07-24 10:17:57 -06:00
Travis Ralston
5ade15534d Remove extra branch in example generation 2018-07-24 10:17:39 -06:00
Travis Ralston
042772aaf5 Make nested titles better 2018-07-24 10:13:23 -06:00
Travis Ralston
cb4fcd1d09 Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger 2018-07-24 09:15:36 -06:00