Skip to content

Commit 6146806

Browse files
authored
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.
1 parent 188eba6 commit 6146806

File tree

18 files changed

+62
-106
lines changed

18 files changed

+62
-106
lines changed

.github/PULL_REQUEST_TEMPLATE/ready-proposal.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE/spec-change.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ assignees: ''
1111

1212
<!-- Please read CONTRIBUTING.rst before submitting your pull request -->
1313

14-
* [ ] Pull request includes a [changelog file](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#adding-to-the-changelog)
15-
* [ ] Pull request includes a [sign off](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#sign-off)
16-
* [ ] Pull request is classified as ['other changes'](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#other-changes)
14+
* [ ] Pull request includes a [changelog file](https://github.com/matrix-org/matrix-spec/blob/master/CONTRIBUTING.rst#adding-to-the-changelog)
15+
* [ ] Pull request includes a [sign off](https://github.com/matrix-org/matrix-spec/blob/master/CONTRIBUTING.rst#sign-off)
16+
* [ ] Pull request is classified as ['other changes'](https://github.com/matrix-org/matrix-spec/blob/master/CONTRIBUTING.rst#other-changes)

.github/PULL_REQUEST_TEMPLATE/wip-proposal.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

CONTRIBUTING.rst

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Contributing to matrix-doc
2-
==========================
1+
Contributing to matrix-spec
2+
===========================
33

44
Everyone is welcome to contribute to the Matrix specification!
55

@@ -9,13 +9,9 @@ Code style
99
----------
1010

1111
The documentation style is described at
12-
https://github.com/matrix-org/matrix-doc/blob/master/meta/documentation_style.rst.
12+
https://github.com/matrix-org/matrix-spec/blob/main/meta/documentation_style.rst.
1313

14-
Python code within the ``matrix-doc`` project should follow the same style as
15-
synapse, which is documented at
16-
https://github.com/matrix-org/synapse/tree/master/docs/code_style.md.
17-
18-
Matrix-doc workflows
14+
Matrix-spec workflows
1915
--------------------
2016

2117
Specification changes
@@ -27,9 +23,7 @@ server before they can be documented in the specification. This process can take
2723
some time to complete.
2824

2925
Changes to the protocol (new endpoints, ideas, etc) need to go through the
30-
`proposals process <https://matrix.org/docs/spec/proposals>`_. Other changes,
31-
such as fixing bugs, typos, or clarifying existing behaviour do not need a proposal.
32-
If you're not sure, visit us at `#matrix-spec:matrix.org`_ and ask.
26+
`proposals process <https://matrix.org/docs/spec/proposals>`_.
3327

3428
Other changes
3529
~~~~~~~~~~~~~
@@ -42,20 +36,20 @@ following:
4236

4337
* Addition of features which have been in use in practice for some time, but
4438
have never made it into the spec (including anything with the `spec-omission
45-
<https://github.com/matrix-org/matrix-doc/labels/spec-omission>`_ label).
39+
<https://github.com/matrix-org/matrix-spec/labels/spec-omission>`_ label).
4640

4741
* Likewise, corrections to the specification, to fix situations where, in
4842
practice, servers and clients behave differently to the specification,
4943
including anything with the `spec-bug
50-
<https://github.com/matrix-org/matrix-doc/labels/spec-bug>`_ label.
44+
<https://github.com/matrix-org/matrix-spec/labels/spec-bug>`_ label.
5145

5246
(If there is any doubt about whether it is the spec or the implementations
5347
that need fixing, please discuss it with us first in `#matrix-spec:matrix.org`_.)
5448

5549
* Clarifications to the specification which do not change the behaviour of
5650
Matrix servers or clients in a way which might introduce compatibility
5751
problems for existing deployments. This includes anything with the
58-
`clarification <https://github.com/matrix-org/matrix-doc/labels/clarification>`_
52+
`clarification <https://github.com/matrix-org/matrix-spec/labels/clarification>`_
5953
label.
6054

6155
For example, areas where the specification is unclear do not require a proposal
@@ -81,7 +75,7 @@ Adding to the changelog
8175
All API specifications require a changelog entry. Adding to the changelog can only
8276
be done after you've opened your pull request, so be sure to do that first.
8377

84-
The changelog is managed by Towncrier (https://github.com/hawkowl/towncrier) in the
78+
The changelog is managed by `Towncrier <https://github.com/twisted/towncrier>`_ in the
8579
form of "news fragments". The news fragments for the client-server API are stored
8680
under ``changelogs/client_server/newsfragments``.
8781

@@ -111,7 +105,7 @@ CSS, etc should not get a news fragment.
111105
Sign off
112106
--------
113107

114-
We ask that everybody who contributes to their project signs off their
108+
We ask that everybody who contributes to this project signs off their
115109
contributions, as explained below.
116110

117111
We follow a simple 'inbound=outbound' model for contributions: the act of
@@ -121,11 +115,10 @@ license - in our case, this is Apache Software License v2 (see LICENSE).
121115

122116
In order to have a concrete record that your contribution is intentional
123117
and you agree to license it under the same terms as the project's license, we've adopted the
124-
same lightweight approach that the Linux Kernel
125-
(https://www.kernel.org/doc/Documentation/SubmittingPatches), Docker
126-
(https://github.com/docker/docker/blob/master/CONTRIBUTING.md), and many other
127-
projects use: the DCO (Developer Certificate of Origin:
128-
http://developercertificate.org/). This is a simple declaration that you wrote
118+
same lightweight approach used by the `Linux Kernel <https://www.kernel.org/doc/html/latest/process/submitting-patches.html>`_,
119+
`Docker <https://github.com/docker/docker/blob/master/CONTRIBUTING.md`_, and many other
120+
projects: the `Developer Certificate of Origin <http://developercertificate.org/>`_
121+
(DCO). This is a simple declaration that you wrote
129122
the contribution or otherwise have the right to contribute it to Matrix::
130123

131124
Developer Certificate of Origin

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,6 @@ there are a number of options:
9898

9999
## Issue tracking
100100

101-
Specification issues are tracked on github at <https://github.com/matrix-org/matrix-doc/issues>.
101+
Specification issues are tracked on github at <https://github.com/matrix-org/matrix-spec/issues>.
102102

103103
See [meta/github-labels.rst](./meta/github-labels.rst) for information on what the labels mean.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update various links which pointed to the old `matrix-doc` github repository.

changelogs/header.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Variables:
99
## VERSION
1010

1111
<table class="release-info">
12-
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-doc/tree/VERSION">https://github.com/matrix-org/matrix-doc/tree/VERSION</a></td>
12+
<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>
1313
<tr><th>Release date</th><td>DATE</td>
1414
</table>
1515

changelogs/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[tool.towncrier]
22
version = "unused"
33
filename = "../rendered.md"
4-
issue_format = "[#{issue}](https://github.com/matrix-org/matrix-doc/issues/{issue})"
4+
issue_format = "[#{issue}](https://github.com/matrix-org/matrix-spec/issues/{issue})"
55
title_format = "### {name}" # Matches rendered spec, even if awkward
66
underlines = " " # 3 spaces intentionally to hide RST headings
77

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update various links which pointed to the old `matrix-doc` github repository.

content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ before using the contents verbatim.
216216
**It is not safe to assume that an event body will have all the expected
217217
fields of the expected types.**
218218

219-
See [MSC2801](https://github.com/matrix-org/matrix-doc/pull/2801) for more
219+
See [MSC2801](https://github.com/matrix-org/matrix-spec-proposals/blob/main/proposals/2801-untrusted-event-data.md) for more
220220
detail on why this assumption is unsafe.
221221
{{% /boxes/warning %}}
222222

0 commit comments

Comments
 (0)