Redirect /changelogs to latest version and adapt heading levels

matrix-org · Sep 9, 2024 · 45e47e9 · 45e47e9
1 parent 4aecf2d
commit 45e47e9
Show file tree

Hide file tree

Showing 18 changed files with 137 additions and 174 deletions.
diff --git a/changelogs/header.md b/changelogs/header.md
@@ -6,8 +6,6 @@ Variables:
     DATE     = Replaced by the date (eg: April 01, 2021)
 -->
 
-## VERSION
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/VERSION">https://github.com/matrix-org/matrix-spec/tree/VERSION</a></td>
 <tr><th>Release date</th><td>DATE</td>

diff --git a/changelogs/template.md.jinja b/changelogs/template.md.jinja
@@ -1,7 +1,7 @@
 {% for section_name, section in sections.items() %}
 {% if section_name %}
 
-### {{section_name}}
+## {{section_name}}
 {% endif %}
 
 {% if section %}

diff --git a/content/changelog/_index.md b/content/changelog/_index.md
@@ -4,44 +4,4 @@ type: docs
 weight: 1000
 ---
 
-{{% changelog/changelog-description %}}
-
 {{% changelog/changelogs %}}
-
-<h2 id="historical-versions" class="no-numbers">Historical versions</h2>
-
-Before version 1.1, versioning was applied at the level of individual API specifications. This section includes links to these versions of the APIs.
-
-* **Client-Server API**
-  -   [r0.6.1](https://matrix.org/docs/spec/client_server/r0.6.1.html)
-  -   [r0.6.0](https://matrix.org/docs/spec/client_server/r0.6.0.html)
-  -   [r0.5.0](https://matrix.org/docs/spec/client_server/r0.5.0.html)
-  -   [r0.4.0](https://matrix.org/docs/spec/client_server/r0.4.0.html)
-  -   [r0.3.0](https://matrix.org/docs/spec/client_server/r0.3.0.html)
-  -   [r0.2.0](https://matrix.org/docs/spec/client_server/r0.2.0.html)
-  -   [r0.1.0](https://matrix.org/docs/spec/client_server/r0.1.0.html)
-  -   [r0.0.1](https://matrix.org/docs/spec/r0.0.1/client_server.html)
-  -   [r0.0.0](https://matrix.org/docs/spec/r0.0.0/client_server.html)
-  -   [Legacy](https://matrix.org/docs/spec/legacy/#client-server-api):
-      The last draft before the spec was formally released in version
-      r0.0.0.
-
-* **Server-Server API**
-  -   [r0.1.4](https://matrix.org/docs/spec/server_server/r0.1.4.html)
-  -   [r0.1.3](https://matrix.org/docs/spec/server_server/r0.1.3.html)
-  -   [r0.1.2](https://matrix.org/docs/spec/server_server/r0.1.2.html)
-  -   [r0.1.1](https://matrix.org/docs/spec/server_server/r0.1.1.html)
-  -   [r0.1.0](https://matrix.org/docs/spec/server_server/r0.1.0.html)
-
-* **Application Service API**
-  -   [r0.1.1](https://matrix.org/docs/spec/application_service/r0.1.1.html)
-  -   [r0.1.0](https://matrix.org/docs/spec/application_service/r0.1.0.html)
-
-* **Identity Service API**
-  -   [r0.3.0](https://matrix.org/docs/spec/identity_service/r0.3.0.html)
-  -   [r0.2.1](https://matrix.org/docs/spec/identity_service/r0.2.1.html)
-  -   [r0.2.0](https://matrix.org/docs/spec/identity_service/r0.2.0.html)
-  -   [r0.1.0](https://matrix.org/docs/spec/identity_service/r0.1.0.html)
-
-* **Push Gateway API**
-  -   [r0.1.0](https://matrix.org/docs/spec/push_gateway/r0.1.0.html)
diff --git a/content/changelog/historical.md b/content/changelog/historical.md
@@ -0,0 +1,48 @@
+---
+title: Historical versions
+type: docs
+outputs:
+  - html
+---
+
+Before version 1.1, versioning was applied at the level of individual API specifications.
+This section includes links to these versions of the APIs.
+
+## Client-Server API
+
+  -   [r0.6.1](https://matrix.org/docs/spec/client_server/r0.6.1.html)
+  -   [r0.6.0](https://matrix.org/docs/spec/client_server/r0.6.0.html)
+  -   [r0.5.0](https://matrix.org/docs/spec/client_server/r0.5.0.html)
+  -   [r0.4.0](https://matrix.org/docs/spec/client_server/r0.4.0.html)
+  -   [r0.3.0](https://matrix.org/docs/spec/client_server/r0.3.0.html)
+  -   [r0.2.0](https://matrix.org/docs/spec/client_server/r0.2.0.html)
+  -   [r0.1.0](https://matrix.org/docs/spec/client_server/r0.1.0.html)
+  -   [r0.0.1](https://matrix.org/docs/spec/r0.0.1/client_server.html)
+  -   [r0.0.0](https://matrix.org/docs/spec/r0.0.0/client_server.html)
+  -   [Legacy](https://matrix.org/docs/spec/legacy/#client-server-api):
+      The last draft before the spec was formally released in version
+      r0.0.0.
+
+## Server-Server API
+
+  -   [r0.1.4](https://matrix.org/docs/spec/server_server/r0.1.4.html)
+  -   [r0.1.3](https://matrix.org/docs/spec/server_server/r0.1.3.html)
+  -   [r0.1.2](https://matrix.org/docs/spec/server_server/r0.1.2.html)
+  -   [r0.1.1](https://matrix.org/docs/spec/server_server/r0.1.1.html)
+  -   [r0.1.0](https://matrix.org/docs/spec/server_server/r0.1.0.html)
+
+## Application Service API
+
+  -   [r0.1.1](https://matrix.org/docs/spec/application_service/r0.1.1.html)
+  -   [r0.1.0](https://matrix.org/docs/spec/application_service/r0.1.0.html)
+
+## Identity Service API
+
+  -   [r0.3.0](https://matrix.org/docs/spec/identity_service/r0.3.0.html)
+  -   [r0.2.1](https://matrix.org/docs/spec/identity_service/r0.2.1.html)
+  -   [r0.2.0](https://matrix.org/docs/spec/identity_service/r0.2.0.html)
+  -   [r0.1.0](https://matrix.org/docs/spec/identity_service/r0.1.0.html)
+
+## Push Gateway API
+
+  -   [r0.1.0](https://matrix.org/docs/spec/push_gateway/r0.1.0.html)
diff --git a/content/changelog/v1.1.md b/content/changelog/v1.1.md
@@ -14,16 +14,14 @@ Variables:
     November 09, 2021     = Replaced by the date (eg: April 01, 2021)
 -->
 
-## v1.1
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-doc/tree/v1.1">https://github.com/matrix-org/matrix-doc/tree/v1.1</a></td>
 <tr><th>Release date</th><td>November 09, 2021</td>
 <tr><th>Checklist</th><td><a href="/changelog/v1.1/checklist.md">checklist.md</a></td>
 </table>
 
 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
-### Client-Server API
+## Client-Server API
 
 
 <strong>Breaking Changes</strong>
@@ -116,7 +114,7 @@ Variables:
 - Fix documentation errors around `threepid_creds`. ([#3471](https://github.com/matrix-org/matrix-doc/issues/3471))
 
 
-### Server-Server API
+## Server-Server API
 
 
 <strong>New Endpoints</strong>
@@ -142,7 +140,7 @@ Variables:
 - Tweak the example PDU diagram to better demonstrate situations with multiple `prev_events`. ([#3340](https://github.com/matrix-org/matrix-doc/issues/3340))
 
 
-### Application Service API
+## Application Service API
 
 
 <strong>Spec Clarifications</strong>
@@ -151,7 +149,7 @@ Variables:
 - Fix various typos throughout the specification. ([#2888](https://github.com/matrix-org/matrix-doc/issues/2888))
 
 
-### Identity Service API
+## Identity Service API
 
 
 <strong>New Endpoints</strong>
@@ -174,7 +172,7 @@ Variables:
 - Describe how [MSC2844](https://github.com/matrix-org/matrix-doc/pull/2844) affects the `/versions` endpoint. ([#3459](https://github.com/matrix-org/matrix-doc/issues/3459))
 
 
-### Push Gateway API
+## Push Gateway API
 
 
 <strong>Spec Clarifications</strong>

diff --git a/content/changelog/v1.10.md b/content/changelog/v1.10.md
@@ -14,8 +14,6 @@ Variables:
     March 22, 2024     = Replaced by the date (eg: April 01, 2021)
 -->
 
-## v1.10
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.10">https://github.com/matrix-org/matrix-spec/tree/v1.10</a></td>
 <tr><th>Release date</th><td>March 22, 2024</td>
@@ -24,7 +22,7 @@ Variables:
 
 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 
-### Client-Server API
+## Client-Server API
 
 **Backwards Compatible Changes**
 
@@ -56,7 +54,7 @@ Variables:
 - Clarify that the `m.push_rules` account data type cannot be set using the `/account_data` API, as per [MSC4010](https://github.com/matrix-org/matrix-spec-proposals/pull/4010). ([#1763](https://github.com/matrix-org/matrix-spec/issues/1763))
 
 
-### Server-Server API
+## Server-Server API
 
 **Spec Clarifications**
 
@@ -65,36 +63,36 @@ Variables:
 - Clarify that the `children_state`, `room_type` and `allowed_room_ids` properties in the items of the `children` array of the response of the `GET /hierarchy` endpoint are not required. ([#1741](https://github.com/matrix-org/matrix-spec/issues/1741))
 
 
-### Application Service API
+## Application Service API
 
 **Spec Clarifications**
 
 - Clarify that the `/login` and `/register` endpoints should fail when using the `m.login.application_service` login type without a valid `as_token`. ([#1744](https://github.com/matrix-org/matrix-spec/issues/1744))
 
 
-### Identity Service API
+## Identity Service API
 
 No significant changes.
 
 
-### Push Gateway API
+## Push Gateway API
 
 No significant changes.
 
 
-### Room Versions
+## Room Versions
 
 **Spec Clarifications**
 
 - For room versions 7 through 11: Clarify that `invite->knock` is not a legal transition. ([#1717](https://github.com/matrix-org/matrix-spec/issues/1717))
 
 
-### Appendices
+## Appendices
 
 No significant changes.
 
 
-### Internal Changes/Tooling
+## Internal Changes/Tooling
 
 **Spec Clarifications**
 

diff --git a/content/changelog/v1.11.md b/content/changelog/v1.11.md
@@ -14,8 +14,6 @@ Variables:
     June 20, 2024     = Replaced by the date (eg: April 01, 2021)
 -->
 
-## v1.11
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.11">https://github.com/matrix-org/matrix-spec/tree/v1.11</a></td>
 <tr><th>Release date</th><td>June 20, 2024</td>
@@ -24,7 +22,7 @@ Variables:
 
 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 
-### Client-Server API
+## Client-Server API
 
 **Deprecations**
 
@@ -69,7 +67,7 @@ Variables:
 - Clarify that `/media/v3/upload/{serverName}/{mediaId}` requires authentication. ([#1872](https://github.com/matrix-org/matrix-spec/issues/1872))
 
 
-### Server-Server API
+## Server-Server API
 
 **Deprecations**
 
@@ -93,26 +91,26 @@ Variables:
 - Fix various typos throughout the specification. ([#1877](https://github.com/matrix-org/matrix-spec/issues/1877))
 
 
-### Application Service API
+## Application Service API
 
 **Spec Clarifications**
 
 - Clarify that appservices should be notified of events relating to the `sender_localpart` user. ([#1810](https://github.com/matrix-org/matrix-spec/issues/1810))
 
 
-### Identity Service API
+## Identity Service API
 
 **Deprecations**
 
 - Authentication using a query string is now deprecated, as per [MSC4126](https://github.com/matrix-org/matrix-spec-proposals/issues/4126). The `Authorization` header should be used instead. ([#1808](https://github.com/matrix-org/matrix-spec/issues/1808))
 
 
-### Push Gateway API
+## Push Gateway API
 
 No significant changes.
 
 
-### Room Versions
+## Room Versions
 
 **Spec Clarifications**
 
@@ -122,7 +120,7 @@ No significant changes.
 - Generate the Table of Contents with Hugo rather than JavaScript. ([#1884](https://github.com/matrix-org/matrix-spec/issues/1884))
 
 
-### Appendices
+## Appendices
 
 **Deprecations**
 
@@ -135,7 +133,7 @@ No significant changes.
 - Move size limits for user, room and event IDs into the appendix and clarify that the length is to be measured in bytes. ([#1850](https://github.com/matrix-org/matrix-spec/issues/1850))
 
 
-### Internal Changes/Tooling
+## Internal Changes/Tooling
 
 **Spec Clarifications**
 

diff --git a/content/changelog/v1.2.md b/content/changelog/v1.2.md
@@ -14,16 +14,14 @@ Variables:
     February 02, 2022     = Replaced by the date (eg: April 01, 2021)
 -->
 
-## v1.2
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-doc/tree/v1.2">https://github.com/matrix-org/matrix-doc/tree/v1.2</a></td>
 <tr><th>Release date</th><td>February 02, 2022</td>
 <tr><th>Checklist</th><td><a href="/changelog/v1.2/checklist.md">checklist.md</a></td>
 </table>
 
 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
-### Client-Server API
+## Client-Server API
 
 
 <strong>Breaking Changes</strong>
@@ -71,7 +69,7 @@ Variables:
 - Fix the rendering of the responses for various API endpoints. ([#3674](https://github.com/matrix-org/matrix-doc/issues/3674))
 
 
-### Server-Server API
+## Server-Server API
 
 
 <strong>New Endpoints</strong>
@@ -94,7 +92,7 @@ Variables:
 - Fix the rendering of the responses for various API endpoints. ([#3674](https://github.com/matrix-org/matrix-doc/issues/3674))
 
 
-### Application Service API
+## Application Service API
 
 
 <strong>Spec Clarifications</strong>
@@ -105,7 +103,7 @@ Variables:
 - Correct the documentation for the response value for `GET /_matrix/app/v1/thirdparty/protocol/{protocol}`. ([#3675](https://github.com/matrix-org/matrix-doc/issues/3675))
 
 
-### Identity Service API
+## Identity Service API
 
 
 <strong>Backwards Compatible Changes</strong>
@@ -120,7 +118,7 @@ Variables:
 - Fix the rendering of the responses for various API endpoints. ([#3674](https://github.com/matrix-org/matrix-doc/issues/3674))
 
 
-### Push Gateway API
+## Push Gateway API
 
 
 <strong>Spec Clarifications</strong>
@@ -129,7 +127,7 @@ Variables:
 - Fix the rendering of the responses for various API endpoints. ([#3674](https://github.com/matrix-org/matrix-doc/issues/3674))
 
 
-### Room Versions
+## Room Versions
 
 
 <strong>Backwards Compatible Changes</strong>
@@ -150,7 +148,7 @@ Variables:
 - Fix auth rules to allow membership of `knock` -> `leave` in v7, v8, and v9. ([#3694](https://github.com/matrix-org/matrix-doc/issues/3694))
 
 
-### Appendices
+## Appendices
 
 
 <strong>Backwards Compatible Changes</strong>