Commit graph

52 commits

Author SHA1 Message Date
Kévin Commaille
b9b10c4920
Remove unused release_date from Hugo config (#2042)
* Remove release_date from Hugo config

It seems unnecessary because it is not used anywhere.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Remove erroneous sentence from Hugo config docs

The version is updated manually during the release (see /meta/releasing.md), not by CI.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2025-01-14 12:34:29 -07:00
Kévin Commaille
6f1e64cb12
Generate changelog release info with Hugo rather than when generating changelog (#2033) 2024-12-23 17:46:52 +00:00
Travis Ralston
baa60bf728
Update path to config in release steps (#2041)
* Update path to config in release steps

* changelog
2024-12-23 08:50:52 -07:00
Kévin Commaille
611d6c3e7e
Always use % delimiter for added-in and changed-in shortcodes (#1975)
The `<>` delimiters are not necessary for the shortcode to be rendered inline, and in some cases they break some expectations: a shortcode that is separated from other text to be in its own paragraph is not actually wrapped by a `p` element, breaking the spacing between paragraphs.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-10-30 10:09:38 +00:00
Kévin Commaille
3af77f0cb4
Fix the table of content for room versions (#1884)
* Fix ToC for room versions pages

Like for the cs-module shortcode, use .RenderShortcodes
instead of .Content for the rver-fragment shortcode,
so the headings are detected by Hugo.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Change the way "this version" is detected in added-in and changed-in shortcodes

Now that we use .RenderShortcodes in the rver-fragment shortcode,
we cannot remove the output of these shortcodes dynamically
because they are replaced by a temporary placeholder due to Hugo's internals.

Instead, since the `this` parameter was only used for room version,
we always use the `v` parameter and compare with the version
provided in the page's front matter.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add version front matter for v11

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Update changelogs/room_versions/newsfragments/1884.clarification

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Travis Ralston <travpc@gmail.com>
2024-06-20 15:47:09 +00:00
Travis Ralston
560f29cff3
Update release documentation (Q2 2024 edition) (#1759)
* Update release documentation (Q2 2024 edition)

* changelog

* Drop the ranges we don't follow

* Don't discourage maintenance

* Patch releases just aren't a good idea
2024-06-20 04:08:20 +00:00
Richard van der Hoff
becc667672
Update github-labels.rst (#1781)
Fix formatting
2024-04-10 07:16:01 +01:00
Kévin Commaille
9fe119370b
Update typos action and fix typos (#1661)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2023-10-11 11:42:05 +01:00
Travis Ralston
903b206e3b
Specify our usage of ABNF for grammar (#1582)
* Specify our usage of ABNF for grammar

* Create 1582.clarification

* Update meta/documentation_style.rst

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>
2023-06-28 08:11:28 -06:00
Travis Ralston
fbb8a789f6
Add release checklist issue template; Document some of our timelines around releases (#1538)
* Add a spec release checklist issue template

because I'm tired of copy/paste

* Document a chunk of our release approach

This should probably go elsewhere, but here is fine for now as a SCT-referenced doc/content.

* changelog

* Brief clarifications
2023-05-25 09:35:38 -06:00
Richard van der Hoff
a45138c3b4
Minor updates to documentation style (#1456)
i.e. has full-stops
2023-02-28 19:04:57 +00:00
Richard van der Hoff
08fde5f257
Generate unstable changelogs using towncrier (#1340)
Replace the current stack of hugo templates with a towncrier invocation. The main advantage of this is that it means that the "Changes since last release" section is consistent with the changelogs for the actual releases.

This also changes the release process so that the changelog is generated before tagging, which means that the thing tagged v1.5 is actually the v1.5 spec.

Fixes #908.
2022-11-15 23:26:55 +00:00
Travis Ralston
1cdfbd3cd8
v1.4 patch release cleanup (#1268)
* Add missing steps to patch release guidelines

* Update from v1.4 patch
2022-10-04 10:00:16 -06:00
Richard van der Hoff
614680675f
Fix broken links to matrix-doc (#1032)
The spec has moved to https://github.com/matrix-org/matrix-spec, so there were
a lot of broken links here.
2022-04-20 16:36:14 +01:00
Travis Ralston
4b78d22e8c release steps: fastforward main 2022-02-02 10:03:19 -07:00
Travis Ralston
d4c74d37a9
Update documentation style & fix room version heading order (#3683)
* Update documentation style & fix room version heading order

Also add a missing signing key section to v6.

This additionally contains various edits to the fragments to have them make a little bit more sense in context.

Finally, this updates various aspects of the documentation style which haven't previously been considered - they're added here considering we're in the area.

* changelog

* enhanced changelogs

* Minor wording adjustments

* Apply suggestions from code review

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>
2022-01-31 15:18:58 -07:00
Aaron Raimist
01cd41de68
Add GitHub Action to check spelling (#3591)
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2021-12-28 09:17:49 -07:00
Travis Ralston
336194aee4
Patch the release process docs (#3568)
* Add a release branch to avoid orphaned commits.
* Specify a patch process.
* Match reality and reference the internal deployment process.

This is largely what we do in practice now, including a created `release/v1.1` branch.
2021-12-21 08:24:43 -07: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
Richard van der Hoff
cafb9ff5a8 Update documentation_style.rst (#3352) 2021-08-27 19:17:18 +01:00
Richard van der Hoff
6afe10409e Update documentation_style.rst (#3351)
hugo tales commonmark.
2021-08-27 19:17:18 +01:00
Travis Ralston
62896cdea9 Apply suggestions from code review
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2021-08-27 19:17:10 +01:00
Travis Ralston
52cd88f070 Rewrite readme and update contributor docs
Incorporates https://github.com/matrix-org/matrix-doc/pull/3025/
2021-08-27 19:17:10 +01:00
Travis Ralston
d37f7a25b4
Make translations for SAS emoji available in-tree (#2728)
* add a base file

* Fix directory name

* Added translation using Weblate (English)

* Translated using Weblate (English)

Currently translated at 1.6% (1 of 64 strings)

Translation: matrix-doc/SAS Emoji v1
Translate-URL: https://translate.riot.im/projects/matrix-doc/sas-emoji-v1/en_EN/

* add english files

* delete english files

* Added translation using Weblate (English)

* Added translation using Weblate (English)

* Do manual translations

* Deleted translation using Weblate (English)

* Deleted translation using Weblate (English)

* Add a script to update the definitions with the translations

* update i18n

* Add a note to the spec about translations

* changelog

* Ensure translations end with json
2020-08-12 14:04:48 -06:00
Richard van der Hoff
ae163ab818
remove some lies about markdown being bad (#2337) 2019-11-01 14:05:54 +00:00
Richard van der Hoff
62cc11eee6 add missing github-labels file 2019-08-30 13:50:00 +01:00
Travis Ralston
b1689a3036 Misc improvements 2019-02-10 18:03:17 -07:00
Travis Ralston
375104127c Fix spec release process to match new changelog stuff
Also while we're here, make it accurate. 

Fixes https://github.com/matrix-org/matrix-doc/issues/1858
2019-02-06 22:03:16 -07:00
Travis Ralston
7d34995ece It's actually an "identity server implementing the Identity Service API"
Also add a note about appservices being special.
2018-08-31 15:35:32 -06:00
Travis Ralston
c94f3619b7 Missed a rogue case of identity server 2018-08-31 15:09:18 -06:00
Travis Ralston
7ac76fa27c Actually we're going with "identity server" afterall 2018-08-31 15:04:00 -06:00
Travis Ralston
ec248b436f Identity Service is lowercase 2018-08-31 15:04:00 -06:00
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.
2018-08-31 15:04:00 -06:00
Travis Ralston
138419cdd4
fix indentation on release process doc 2018-08-30 11:19:55 -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
Travis Ralston
e141f61df3 Update release instructions to reference symlinks, what files to update, etc 2018-08-20 14:05:48 -06:00
Travis Ralston
5b73a0174d Clarify what the release branch is used for, and how it should be named 2018-08-20 14:05:23 -06:00
Richard van der Hoff
c2ed79bd1a
Sentence case for headings 2018-08-17 17:07:03 +01: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
Richard van der Hoff
2605c75f92
typo 2018-06-22 14:31:31 +01:00
Richard van der Hoff
c84066df89
do not use 'optional' in descriptions. 2018-06-22 14:30:24 +01:00
Richard van der Hoff
dfa4af5c19
record that "identity server" has two words 2018-06-22 11:08:19 +01:00
Richard van der Hoff
3c7db643c3
Update documentation_style.rst
spell homeserver
2018-04-19 16:04:47 +01:00
Richard van der Hoff
196e668768
Update documentation_style.rst 2018-02-14 16:44:09 +00:00
Richard van der Hoff
0a917b2c70
documentation_style typo 2018-02-14 07:08:01 +00:00
Richard van der Hoff
1028ea3558
doc style: lists 2018-02-06 17:30:22 +00:00
Richard van der Hoff
3c40d5a94e
documentation_style: fix indentation 2018-02-06 16:10:55 +00:00
Richard van der Hoff
306783b7bf notes on doc style 2018-02-06 16:09:53 +00:00
Richard van der Hoff
91c1d9ed58
documentation_style.rst: Fix rst syntax
apparently the rst parser gets confused by '- `````'.
2018-02-06 14:58:59 +00:00
Richard van der Hoff
b5d68b8ff1 Link to doc style doc
(and update it to cover extra section characters)
2016-07-14 10:13:10 +01:00