Commit graph

39 commits

Author SHA1 Message Date
Travis Ralston
0dd3fa481b Fix changelog 2022-06-16 09:17:08 -06:00
Travis Ralston
98db9a6d04 v1.3 changelog generation 2022-06-16 08:31:07 -06:00
Hubert Chathi
2780055198
clarify federation Authorization header an add destination property (#1067)
* clarify federation Authorization header an add destination property

* add changelogs

* some clarifications

* more clarifications, fixes

* use HTML in the added-in/changed-in shortcodes

* Apply suggestions from code review

Co-authored-by: Travis Ralston <travpc@gmail.com>
2022-05-30 15:33:56 -06:00
Travis Ralston
fd2d5b8a49
Fix a few more instances of matrix-doc being used; Fix changelog support for repo split (#1051)
* Use spec-proposals repo for links in spec text and current changelog

* Make the changelog repo-aware

* Changelog
2022-05-10 08:59:54 -06:00
Richard van der Hoff
dfb1bf2a5d
Fix x-changedInMatrixVersion for API parameters (#1011) 2022-03-29 23:17:51 +01:00
Andrew Morgan
5a54ca66d1
Replace deprecated Page.Dir with Page.File.Dir (#988) 2022-03-29 15:03:41 +01:00
Richard van der Hoff
f989d323c0
Update v1.2 changelog with missed PR (#3705) 2022-02-11 11:05:49 +00:00
Travis Ralston
e488a7fb6d v1.2 changelog 2022-02-02 10:05:30 -07:00
Richard van der Hoff
c3b53d5ae6
comments on resolve-allof (#3657) 2022-01-26 10:50:48 +00:00
Richard van der Hoff
783624d2cd
Fix rendering of responses with empty bodies (#3674) 2022-01-26 10:50:09 +00:00
Travis Ralston
26e0765159
Add guest changes to spec: MSC3069 and MSC3419 (#3605)
* Add MSC3069 support

https://github.com/matrix-org/matrix-doc/pull/3069

* Add MSC3419 support

https://github.com/matrix-org/matrix-doc/pull/3419

* Normalize and fix guest access endpoints list

* Changelogs
2022-01-04 20:29:40 -07:00
Travis Ralston
00169abcdb
Specify module order manually to work around hugo issues (#3612) 2022-01-04 20:29:10 -07:00
Travis Ralston
20bd445602
Add a changelog for the appendices (#3609)
As a document which is versioned, we should have a changelog for it. It might be empty most of the time but oh well.
2022-01-04 20:23:02 -07:00
Richard van der Hoff
3be746c9d3
Fix rendering of response examples (#3584)
* Fix rendering of response examples

Fixes the autogeneration of JSON examples for array objects. This fixes a
number of "Specification error: Example invalid or not present" errors in the
rendered spec.

* Unbreak examples for non-objects/arrays

The previous change had broken auto-generated examples for everything that
wasn't an object or array; fix it up again.

* Remove conditions on $example

Everything should now have a generated example, so the condition is
redundant. Furthermore it was suppressing examples for APIs where the example
was an empty dict.
2022-01-04 16:47:58 +00:00
Richard van der Hoff
7f200c53e8
Move prev_content to unsigned (#3524) 2021-12-02 17:22:58 +00:00
Richard van der Hoff
92b29cf8e6
Add a changelog directory for room versions (#3504) 2021-11-19 11:00:37 +00:00
Travis Ralston
67d73438ea Backport typo fix 2021-11-09 08:19:21 -07:00
Travis Ralston
195b8a54c5 v1.1 changelog 2021-11-09 07:23:27 -07:00
Travis Ralston
241e01c332
Fully specify room versions (#3432)
* Fully specify room versions

* Misc typo clarifications

* Try to clarify redactions a bit

* Update content/client-server-api/_index.md

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

* Update content/rooms/v6.md

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

* Update content/rooms/v6.md

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

* Better describe client considerations

* Doc template params

* Move redaction "new stuff" to v3

* Remove unhelpful sentences about "here follows unchanged stuff"

* Simplify event signing text

* Clean up handling redactions sections

* Move v4's event schema to unchanged section

* Update content/rooms/v4.md

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

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2021-11-01 08:49:15 -06:00
Travis Ralston
e8674688e6
Release process: changelog generation and docs (#3446)
* Remove extra pyprojects and update changelog docs

* Add script for rendering the changelog

* Add docs for how to release the spec

* Move legacy changelogs out of the way
2021-10-18 10:09:35 -06:00
Travis Ralston
5be0df02c5
Start annotating which version of the spec added a thing (#3425)
* Introduce a new "added-in" template and use it on endpoints

* Use "added-in" on schema properties too

* Annotate sections of the spec with their added versions

* Demo of "added-in" on a room version (to be fleshed out)

* Use clearer versioning semantics

* Update and fix validator for Swagger custom properties

* Fix docs
2021-10-14 13:23:04 -06:00
Travis Ralston
95d850c418
Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421)
* Blind find & replace all on client major version -> v3

* Fix up bad replacements

* Fix anchors for r0->v3

* Changelog
2021-10-12 11:07:01 -06:00
Andrew Morgan
ff2c93af1c Use changelogs/release.yaml for the version number source everywhere (#3310)
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2021-08-27 19:17:17 +01:00
Andrew Morgan
97f8e1248b Attempt to fix broken breadcrumb links
Apparently this is a bug when canonifyURLs = true, which is a required option
to fix relative urls on spec pages.
2021-08-27 19:17:07 +01:00
wbamberg
1bfc3de6d6 Merge pull request #2992 from wbamberg/support-changelogs
Support changelogs
2021-08-27 19:16:42 +01:00
Will
25924a498c Fix tab/spaces mix 2021-08-27 19:16:42 +01:00
Will
643cdd19c8 Support rendering of proposal tables 2021-08-27 19:16:42 +01:00
wbamberg
07c66616ac Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2021-08-27 19:16:42 +01:00
wbamberg
6fc1f52f2f Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2021-08-27 19:16:42 +01:00
wbamberg
942f865f64 Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2021-08-27 19:16:42 +01:00
Will
5f45a897ef Add templates used to render data 2021-08-27 19:16:42 +01:00
Will
ee87cf2b63
Undo support for patch versions; use an opaque version string 2021-02-08 20:35:04 -08:00
Will
b79d489f91
Fix comment in changelog template 2021-02-03 14:18:06 -08:00
Will
9f3df1950f
Add changelog page and templates 2021-02-02 20:47:18 -08:00
Will
183ecfda03
Replace sas-emojis template 2021-01-22 14:31:39 -08:00
Will
338434bfcd
Support alerts (notes, warnings, rationales) 2021-01-20 12:34:49 -08:00
Will
228c737f56
Add support for modules 2021-01-19 15:57:35 -08:00
Will
0abbb1857f
Comments for all the layout templates 2021-01-12 20:45:24 -08:00
Will
55eae7b70b
Render a single page of the spec in Hugo 2021-01-12 15:31:01 -08:00