docs-matrix-spec/changelogs
Kévin Commaille 9068c336f4
Clarify that sdpMid and sdpMLineIndex are not required in m.call.candidates (#1742)
* Convert m.call.candidates schema to YAML

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

* Clarify that sdpMid and sdpMLineIndex are not required in `m.call.candidates`

MSC2746, merged in v1.17,
introduced the end-of-candidates candidate,
where only the `candidate` property is set to an empty string.

Besides, the [WebRTC specification](https://www.w3.org/TR/webrtc/)
says that only one of those fields is required in a normal candidate.

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

* Add changelog

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

* Link to the "End-of-candidates" section, and clarify what "empty" means

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

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-03-07 21:13:38 -05:00
..
appendices/newsfragments Matrix 1.9 2023-11-29 10:05:20 -07:00
application_service/newsfragments Normalize changelog for 1.9 2023-11-27 15:58:06 -07:00
client_server/newsfragments Clarify that sdpMid and sdpMLineIndex are not required in m.call.candidates (#1742) 2024-03-07 21:13:38 -05:00
identity_service/newsfragments Matrix 1.8 changelog 2023-08-23 09:24:08 -06:00
internal/newsfragments Update HTML templates to link to object definitions (#1724) 2024-02-28 10:39:08 +00:00
legacy Add a hyphen between third and party when used as an adjective (#1447) 2023-03-08 09:58:29 +00:00
push_gateway/newsfragments Matrix 1.6 2023-02-14 08:26:14 -07:00
room_versions/newsfragments Clarify that invite->knock is not a valid transition (#1717) 2024-02-21 14:16:40 -07:00
server_server/newsfragments Disambiguate uses of PublicRoomsChunk` (#1740) 2024-03-06 19:48:09 -05:00
header.md Fix broken links to matrix-doc (#1032) 2022-04-20 16:36:14 +01:00
pyproject.toml Fix rendered changelog with new version of towncrier (#1598) 2023-07-18 17:52:38 +01:00
README.md Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
template.md.jinja Fix rendered changelog with new version of towncrier (#1598) 2023-07-18 17:52:38 +01:00

Changelogs

Towncrier is used to manage the changelog and keep it up to date. Because of this, updating a changelog is really easy.

Generating the changelog

Please see the release docs for more information.

Creating a new changelog

There are a few places you'll have to update:

  • /layouts/shortcodes/changelog/changelog-changes.html to account for the new changelog.
  • /scripts/generate-changelog.sh to render the changelog for releases.
  • Supporting documentation such as the contributing guidelines.