Commit graph

12 commits

Author SHA1 Message Date
Travis Ralston
2877459553 Add a link to the push module in the push gateway spec 2020-09-02 14:04:55 -06:00
Aaron Raimist
fe7f582233
Fix several spelling mistakes
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2019-02-01 16:43:46 -06: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
a46783eb24 Revert "Take out the reference to the current version from the changelog"
This reverts commit 2a20c11467.
2018-08-29 18:10:03 -06:00
Travis Ralston
2a20c11467 Take out the reference to the current version from the changelog 2018-08-29 17:54:48 -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
Travis Ralston
de961fb7d6 Improve wording on push gateways 2018-08-15 11:59:58 -06:00
Richard van der Hoff
49cd65dd58 Add a license to the spec
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
2016-07-12 17:28:30 +01:00
Richard van der Hoff
5cc9066159 Add git versions to other parts of the spec 2016-05-06 09:49:26 +01:00
David Baker
71cb646541 Change id in the push gateway poke to be event_id and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec. 2016-04-06 18:28:21 +01:00
Kegan Dougal
bca3add9a7 Formatting 2015-12-08 16:38:48 +00:00
Kegan Dougal
d01ff6b495 Add noddy push gateway placeholder 2015-12-08 16:37:51 +00:00