Skip to content

Commit

Permalink
Stop rendering CS modules and room version fragments as standalone pa…
Browse files Browse the repository at this point in the history
…ges (matrix-org#1317)

This is actually doing two things:

 * creating `{fragments,modules}/index.md` turns the fragments and modules into
   page resources, rather than pages in their own right. We have to update the
   shortcodes to match.

 * adding `headless: true` means that we don't render the pages.

The net effect is that we don't render pages like
https://spec.matrix.org/v1.4/rooms/fragments/v1-auth-rules/ and
https://spec.matrix.org/v1.4/client-server-api/modules/account_data/.
  • Loading branch information
richvdh authored and clokep committed May 3, 2023
1 parent 7cbb04f commit 0661880
Show file tree
Hide file tree
Showing 59 changed files with 21 additions and 165 deletions.
1 change: 1 addition & 0 deletions changelogs/internal/newsfragments/1317.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Stop rendering the subsections of the Client-Server API and Room Versions specs as their own separate pages.
3 changes: 0 additions & 3 deletions content/client-server-api/modules/account_data.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Client Config

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Server Administration

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/content_repo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Content repository

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/device_management.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Device Management

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/dm.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Direct Messaging

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/end_to_end_encryption.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### End-to-End Encryption

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/event_context.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Event Context

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/event_replacements.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Event replacements

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/guest_access.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Guest Access

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/history_visibility.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Room History Visibility

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/ignore_users.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Ignoring Users

Expand Down
3 changes: 3 additions & 0 deletions content/client-server-api/modules/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
headless: true
---
3 changes: 0 additions & 3 deletions content/client-server-api/modules/instant_messaging.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Instant Messaging

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/mentions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### User and room mentions

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/moderation_policies.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Moderation policy lists

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/openid.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### OpenID

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/presence.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Presence

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/push.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Push Notifications

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/read_markers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Fully read markers

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/receipts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Receipts

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/reference_relations.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Reference relations

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/report_content.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Reporting Content

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/rich_replies.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Rich replies

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/room_previews.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Room Previews

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/room_upgrades.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Room Upgrades

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/search.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Server Side Search

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/secrets.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Secrets

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/send_to_device.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Send-to-Device messaging

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/server_acls.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Server Access Control Lists (ACLs) for rooms

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/server_notices.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Server Notices

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/spaces.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
type: module
weight: 340
---

### Spaces

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/sso_login.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### SSO client login/authentication

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/stickers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Sticker Messages

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/tags.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Room Tagging

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/third_party_invites.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Third party invites

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/third_party_networks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Third Party Networks

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/threading.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Threading

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/typing_notifications.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Typing Notifications

Expand Down
3 changes: 0 additions & 3 deletions content/client-server-api/modules/voip_events.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
type: module
---

### Voice over IP

Expand Down
3 changes: 3 additions & 0 deletions content/rooms/fragments/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
headless: true
---
3 changes: 0 additions & 3 deletions content/rooms/fragments/v1-auth-rules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
toc_hide: true
---

The types of state events that affect authorization are:

Expand Down
3 changes: 0 additions & 3 deletions content/rooms/fragments/v1-canonical-json.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
toc_hide: true
---

Servers MUST NOT strictly enforce the JSON format specified in the
[appendices](/appendices#canonical-json) for the reasons
Expand Down
3 changes: 0 additions & 3 deletions content/rooms/fragments/v1-deprecated-formatting-off-spec.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
toc_hide: true
---

Events sent into rooms of this version can have formats which are different
from their normal schema. Those cases are documented here.
Expand Down
3 changes: 0 additions & 3 deletions content/rooms/fragments/v1-redactions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
toc_hide: true
---

Upon receipt of a redaction event, the server must strip off any keys
not in the following list:
Expand Down
3 changes: 0 additions & 3 deletions content/rooms/fragments/v1-stringy-power-levels.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
toc_hide: true
---

##### `m.room.power_levels` events accept values as strings

Expand Down
3 changes: 0 additions & 3 deletions content/rooms/fragments/v2-state-res.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
toc_hide: true
---

The room state *S′(E)* after an event *E* is defined in terms of the
room state *S(E)* before *E*, and depends on whether *E* is a state
Expand Down
2 changes: 0 additions & 2 deletions content/rooms/fragments/v3-auth-rules.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
toc_hide: true
---

{{< added-in this=true >}} In room versions 1 and 2, events need a
signature from the domain of the `event_id` in order to be considered
valid. This room version does not include an `event_id` over federation
Expand Down
2 changes: 0 additions & 2 deletions content/rooms/fragments/v3-handling-redactions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
toc_hide: true
---

{{% added-in this=true %}} In room versions 1 and 2, redactions were
explicitly part of the [authorization rules](/rooms/v1/#authorization-rules)
under Rule 11. As of room version 3, these conditions no longer exist as
Expand Down
3 changes: 0 additions & 3 deletions content/rooms/fragments/v4-event-format.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
toc_hide: true
---

Events in rooms of this version have the following structure:

Expand Down
2 changes: 0 additions & 2 deletions content/rooms/fragments/v4-event-ids.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
toc_hide: true
---

{{% added-in this=true %}} The event ID is the [reference
hash](/server-server-api#calculating-the-reference-hash-for-an-event) of
the event encoded using a variation of [Unpadded
Expand Down
3 changes: 0 additions & 3 deletions content/rooms/fragments/v5-signing-requirements.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
toc_hide: true
---

When validating event signatures, servers MUST enforce the
`valid_until_ts` property from a key request is at least as large as the
Expand Down
3 changes: 0 additions & 3 deletions content/rooms/fragments/v6-canonical-json.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
toc_hide: true
---

Servers MUST strictly enforce the JSON format specified in the
[appendices](/appendices#canonical-json). This translates to a
Expand Down
3 changes: 0 additions & 3 deletions content/rooms/fragments/v6-redactions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
toc_hide: true
---

Upon receipt of a redaction event, the server must strip off any keys
not in the following list:
Expand Down
3 changes: 0 additions & 3 deletions content/rooms/fragments/v8-auth-rules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
toc_hide: true
---

Events must be signed by the server denoted by the `sender` property.

Expand Down
1 change: 0 additions & 1 deletion content/rooms/fragments/v9-redactions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
toc_hide: true
---

{{% added-in this=true %}} `m.room.member` events now keep `join_authorised_via_users_server`
Expand Down
Loading

0 comments on commit 0661880

Please sign in to comment.