From 614680675fba7a6fbb2f5d112e4dc498102317c0 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Wed, 20 Apr 2022 16:36:14 +0100 Subject: [PATCH] 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. --- .../PULL_REQUEST_TEMPLATE/ready-proposal.md | 19 ---------- .github/PULL_REQUEST_TEMPLATE/spec-change.md | 6 ++-- .github/PULL_REQUEST_TEMPLATE/wip-proposal.md | 20 ----------- CONTRIBUTING.rst | 35 ++++++++---------- README.md | 2 +- .../newsfragments/1032.clarification | 1 + changelogs/header.md | 2 +- changelogs/pyproject.toml | 2 +- .../newsfragments/1032.clarification | 1 + content/_index.md | 2 +- content/appendices.md | 6 ++-- content/identity-service-api.md | 2 +- content/proposals.md | 36 +++++++++---------- content/server-server-api.md | 2 +- .../definitions/sso_login_flow.yaml | 2 +- informal/idp-brands.md | 2 +- meta/github-labels.rst | 22 ++++++------ package.json | 6 ++-- 18 files changed, 62 insertions(+), 106 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE/ready-proposal.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/wip-proposal.md create mode 100644 changelogs/client_server/newsfragments/1032.clarification create mode 100644 changelogs/server_server/newsfragments/1032.clarification diff --git a/.github/PULL_REQUEST_TEMPLATE/ready-proposal.md b/.github/PULL_REQUEST_TEMPLATE/ready-proposal.md deleted file mode 100644 index afa808b8..00000000 --- a/.github/PULL_REQUEST_TEMPLATE/ready-proposal.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Proposal ready for review -about: A proposal that is ready for review by the core team and community. -title: '' -labels: proposal, proposal-in-review -assignees: '' - ---- - - - -### Pull Request Checklist - - - -* [ ] Pull request includes a [changelog file](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#adding-to-the-changelog) -* [ ] Pull request includes a [sign off](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#sign-off) -* [ ] Pull request includes ['Rendered' link](https://matrix.org/docs/spec/proposals#process) above. -* [ ] Pull request title and file name include this PR's number as the MSC number. diff --git a/.github/PULL_REQUEST_TEMPLATE/spec-change.md b/.github/PULL_REQUEST_TEMPLATE/spec-change.md index d2f6e874..362c6862 100644 --- a/.github/PULL_REQUEST_TEMPLATE/spec-change.md +++ b/.github/PULL_REQUEST_TEMPLATE/spec-change.md @@ -11,6 +11,6 @@ assignees: '' -* [ ] Pull request includes a [changelog file](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#adding-to-the-changelog) -* [ ] Pull request includes a [sign off](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#sign-off) -* [ ] Pull request is classified as ['other changes'](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#other-changes) +* [ ] Pull request includes a [changelog file](https://github.com/matrix-org/matrix-spec/blob/master/CONTRIBUTING.rst#adding-to-the-changelog) +* [ ] Pull request includes a [sign off](https://github.com/matrix-org/matrix-spec/blob/master/CONTRIBUTING.rst#sign-off) +* [ ] Pull request is classified as ['other changes'](https://github.com/matrix-org/matrix-spec/blob/master/CONTRIBUTING.rst#other-changes) diff --git a/.github/PULL_REQUEST_TEMPLATE/wip-proposal.md b/.github/PULL_REQUEST_TEMPLATE/wip-proposal.md deleted file mode 100644 index 34e26187..00000000 --- a/.github/PULL_REQUEST_TEMPLATE/wip-proposal.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: WIP Proposal -about: A proposal that isn't quite ready for formal review yet. -title: '[WIP] Your Proposal Title' -labels: proposal -assignees: '' - ---- - - - -### Pull Request Checklist - - - -* [ ] Pull request includes a [changelog file](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#adding-to-the-changelog) -* [ ] Pull request includes a [sign off](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#sign-off) -* [ ] A ['Rendered' link](https://matrix.org/docs/spec/proposals#process) above. -* [ ] Update the title and file name of your proposal to match this PR's number (after opening). -* [ ] Ask in [#matrix-spec:matrix.org](https://matrix.to/#/#matrix-spec:matrix.org) to get this marked as ready for review, once it is ready for review. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 2e72e186..86ed1595 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,5 +1,5 @@ -Contributing to matrix-doc -========================== +Contributing to matrix-spec +=========================== Everyone is welcome to contribute to the Matrix specification! @@ -9,13 +9,9 @@ Code style ---------- The documentation style is described at -https://github.com/matrix-org/matrix-doc/blob/master/meta/documentation_style.rst. +https://github.com/matrix-org/matrix-spec/blob/main/meta/documentation_style.rst. -Python code within the ``matrix-doc`` project should follow the same style as -synapse, which is documented at -https://github.com/matrix-org/synapse/tree/master/docs/code_style.md. - -Matrix-doc workflows +Matrix-spec workflows -------------------- Specification changes @@ -27,9 +23,7 @@ server before they can be documented in the specification. This process can take some time to complete. Changes to the protocol (new endpoints, ideas, etc) need to go through the -`proposals process `_. Other changes, -such as fixing bugs, typos, or clarifying existing behaviour do not need a proposal. -If you're not sure, visit us at `#matrix-spec:matrix.org`_ and ask. +`proposals process `_. Other changes ~~~~~~~~~~~~~ @@ -42,12 +36,12 @@ following: * Addition of features which have been in use in practice for some time, but have never made it into the spec (including anything with the `spec-omission - `_ label). + `_ label). * Likewise, corrections to the specification, to fix situations where, in practice, servers and clients behave differently to the specification, including anything with the `spec-bug - `_ label. + `_ label. (If there is any doubt about whether it is the spec or the implementations that need fixing, please discuss it with us first in `#matrix-spec:matrix.org`_.) @@ -55,7 +49,7 @@ following: * Clarifications to the specification which do not change the behaviour of Matrix servers or clients in a way which might introduce compatibility problems for existing deployments. This includes anything with the - `clarification `_ + `clarification `_ label. For example, areas where the specification is unclear do not require a proposal @@ -81,7 +75,7 @@ Adding to the changelog All API specifications require a changelog entry. Adding to the changelog can only be done after you've opened your pull request, so be sure to do that first. -The changelog is managed by Towncrier (https://github.com/hawkowl/towncrier) in the +The changelog is managed by `Towncrier `_ in the form of "news fragments". The news fragments for the client-server API are stored under ``changelogs/client_server/newsfragments``. @@ -111,7 +105,7 @@ CSS, etc should not get a news fragment. Sign off -------- -We ask that everybody who contributes to their project signs off their +We ask that everybody who contributes to this project signs off their contributions, as explained below. 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). In order to have a concrete record that your contribution is intentional and you agree to license it under the same terms as the project's license, we've adopted the -same lightweight approach that the Linux Kernel -(https://www.kernel.org/doc/Documentation/SubmittingPatches), Docker -(https://github.com/docker/docker/blob/master/CONTRIBUTING.md), and many other -projects use: the DCO (Developer Certificate of Origin: -http://developercertificate.org/). This is a simple declaration that you wrote +same lightweight approach used by the `Linux Kernel `_, +`Docker `_ +(DCO). This is a simple declaration that you wrote the contribution or otherwise have the right to contribute it to Matrix:: Developer Certificate of Origin diff --git a/README.md b/README.md index d977c04e..29028e01 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,6 @@ there are a number of options: ## Issue tracking -Specification issues are tracked on github at . +Specification issues are tracked on github at . See [meta/github-labels.rst](./meta/github-labels.rst) for information on what the labels mean. diff --git a/changelogs/client_server/newsfragments/1032.clarification b/changelogs/client_server/newsfragments/1032.clarification new file mode 100644 index 00000000..66003ac1 --- /dev/null +++ b/changelogs/client_server/newsfragments/1032.clarification @@ -0,0 +1 @@ +Update various links which pointed to the old `matrix-doc` github repository. diff --git a/changelogs/header.md b/changelogs/header.md index 2b98c8a1..21b35106 100644 --- a/changelogs/header.md +++ b/changelogs/header.md @@ -9,7 +9,7 @@ Variables: ## VERSION - +
Git commithttps://github.com/matrix-org/matrix-doc/tree/VERSION
Git commithttps://github.com/matrix-org/matrix-spec/tree/VERSION
Release dateDATE
diff --git a/changelogs/pyproject.toml b/changelogs/pyproject.toml index f114a178..d32f6415 100644 --- a/changelogs/pyproject.toml +++ b/changelogs/pyproject.toml @@ -1,7 +1,7 @@ [tool.towncrier] version = "unused" filename = "../rendered.md" - issue_format = "[#{issue}](https://github.com/matrix-org/matrix-doc/issues/{issue})" + issue_format = "[#{issue}](https://github.com/matrix-org/matrix-spec/issues/{issue})" title_format = "### {name}" # Matches rendered spec, even if awkward underlines = " " # 3 spaces intentionally to hide RST headings diff --git a/changelogs/server_server/newsfragments/1032.clarification b/changelogs/server_server/newsfragments/1032.clarification new file mode 100644 index 00000000..66003ac1 --- /dev/null +++ b/changelogs/server_server/newsfragments/1032.clarification @@ -0,0 +1 @@ +Update various links which pointed to the old `matrix-doc` github repository. diff --git a/content/_index.md b/content/_index.md index 69d7883c..436e2765 100644 --- a/content/_index.md +++ b/content/_index.md @@ -216,7 +216,7 @@ before using the contents verbatim. **It is not safe to assume that an event body will have all the expected fields of the expected types.** -See [MSC2801](https://github.com/matrix-org/matrix-doc/pull/2801) for more +See [MSC2801](https://github.com/matrix-org/matrix-spec-proposals/blob/main/proposals/2801-untrusted-event-data.md) for more detail on why this assumption is unsafe. {{% /boxes/warning %}} diff --git a/content/appendices.md b/content/appendices.md index 2b6de33e..203c650a 100644 --- a/content/appendices.md +++ b/content/appendices.md @@ -751,7 +751,7 @@ this specification are the following: Matrix URIs referring to a room ID. Matrix URIs can additionally use this `via` parameter for non-public federation resolution of identifiers (i.e.: listing a server which might have information about the given user) while a more comprehensive - way is being worked out, such as one proposed by [MSC3020](https://github.com/matrix-org/matrix-doc/pull/3020). + way is being worked out, such as one proposed by [MSC3020](https://github.com/matrix-org/matrix-spec-proposals/pull/3020). Custom query parameters can be specified using the [Common Namespaced Identifier format](#common-namespaced-identifier-grammar) and @@ -772,7 +772,7 @@ Examples of common URIs are: * Link to chat with `@alice:example.org`: `matrix:u/alice:example.org?action=chat` A suggested client implementation algorithm is available in the -[original MSC](https://github.com/matrix-org/matrix-doc/blob/main/proposals/2312-matrix-uri.md#recommended-implementation). +[original MSC](https://github.com/matrix-org/matrix-spec-proposals/blob/main/proposals/2312-matrix-uri.md#recommended-implementation). ##### matrix.to navigation @@ -846,7 +846,7 @@ send requests to. This is partially mitigated with the addition of a `via` argument on a URI, however the problem of routability is still present. Clients should do their best to route Room IDs to where they need to go, however they should also be aware of [issue -\#1579](https://github.com/matrix-org/matrix-doc/issues/1579). +\#1579](https://github.com/matrix-org/matrix-spec/issues/355). A room (or room permalink) which isn't using a room alias should supply at least one server using `via` in the URI's query string. Multiple servers diff --git a/content/identity-service-api.md b/content/identity-service-api.md index aa648098..65369b3e 100644 --- a/content/identity-service-api.md +++ b/content/identity-service-api.md @@ -285,7 +285,7 @@ the client has made an appropriate request to `/hash_details` first. ### Security considerations {{% boxes/note %}} -[MSC2134](https://github.com/matrix-org/matrix-doc/pull/2134) has much +[MSC2134](https://github.com/matrix-org/matrix-spec-proposals/blob/main/proposals/2134-identity-hash-lookup.md) has much more information about the security considerations made for this section of the specification. This section covers the high-level details for why the specification is the way it is. diff --git a/content/proposals.md b/content/proposals.md index dbd2e67e..2d13cafa 100644 --- a/content/proposals.md +++ b/content/proposals.md @@ -16,7 +16,7 @@ for more information on what does and does not need a proposal. The proposal process involves some technical writing, having it reviewed by everyone, having the proposal being accepted, then actually having your ideas implemented as committed changes to the [Specification -repository](https://github.com/matrix-org/matrix-doc). +repository](https://github.com/matrix-org/matrix-spec). Meet the [members of the Core Team](https://matrix.org/foundation), a group of individuals tasked with ensuring the spec process is as smooth @@ -186,7 +186,7 @@ is as follows: changes, and give reasoning to back them up. Changes without justification will likely be poorly received by the community. - Fork and make a PR to the - [matrix-doc](https://github.com/matrix-org/matrix-doc) repository. + [matrix-spec-proposals](https://github.com/matrix-org/matrix-spec-proposals) repository. The ID of your PR will become the MSC ID for the lifetime of your proposal. - The proposal must live in the `proposals/` directory with a @@ -274,8 +274,8 @@ is as follows: The process for handling proposals is shown visually in the following diagram. Note that the lifetime of a proposal is tracked through the corresponding labels for each stage on the -[matrix-doc](https://github.com/matrix-org/matrix-doc) issue and pull -request trackers. +[matrix-spec-proposals](https://github.com/matrix-org/matrix-spec-proposals) +pull request trackers. ``` + + @@ -332,17 +332,17 @@ request trackers. | Name | GitHub Label | Description | |---------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Proposal Drafting and Feedback | [No label](https://github.com/matrix-org/matrix-doc/issues?q=label%3Aproposal+-label%3Aabandoned+-label%3Afinal-comment-period+-label%3Afinished-final-comment-period+-label%3Amerged+-label%3Aobsolete+-label%3Aproposal-postponed+-label%3Aproposed-final-comment-period+-label%3Aproposal-in-review+-label%3Aspec-pr-in-review+-label%3Aspec-pr-missing) | A proposal document which is still work-in-progress but is being shared to incorporate feedback. Please prefix your proposal's title with `[WIP]` to make it easier for reviewers to skim their notifications list. | -| Proposal In Review | [proposal-in-review](https://github.com/matrix-org/matrix-doc/issues?q=label%3Aproposal+label%3Aproposal-in-review) | A proposal document which is now ready and waiting for review by the Spec Core Team and community | -| Proposed Final Comment Period | [proposed-final-comment-period](https://github.com/matrix-org/matrix-doc/issues?q=label%3Aproposal+label%3Aproposed-final-comment-period+) | Currently awaiting signoff of a 75% majority of team members in order to enter the final comment period | -| Final Comment Period | [final-comment-period](https://github.com/matrix-org/matrix-doc/issues?q=label%3Aproposal+label%3Afinal-comment-period+) | A proposal document which has reached final comment period either for merge, closure or postponement | -| Final Comment Period Complete | [finished-final-comment-period](https://github.com/matrix-org/matrix-doc/issues?q=label%3Aproposal+label%3Afinished-final-comment-period+) | The final comment period has been completed. Waiting for a demonstration implementation | -| Spec PR Missing | [spec-pr-missing](https://github.com/matrix-org/matrix-doc/issues?q=label%3Aproposal+label%3Aspec-pr-missing) | The proposal has been agreed, and proven with a demonstration implementation. Waiting for a PR against the Spec | -| Spec PR In Review | [spec-pr-in-review](https://github.com/matrix-org/matrix-doc/issues?q=label%3Aproposal+label%3Aspec-pr-in-review+) | The spec PR has been written, and is currently under review | -| Spec PR Merged | [merged](https://github.com/matrix-org/matrix-doc/issues?q=label%3Aproposal+label%3Amerged) | A proposal with a sufficient working implementation and whose Spec PR has been merged! | -| Postponed | [proposal-postponed](https://github.com/matrix-org/matrix-doc/issues?q=label%3Aproposal+label%3Aproposal-postponed+) | A proposal that is temporarily blocked or a feature that may not be useful currently but perhaps sometime in the future | -| Abandoned | [abandoned](https://github.com/matrix-org/matrix-doc/issues?q=label%3Aproposal+label%3Aabandoned) | A proposal where the author/shepherd is not responsive | -| Obsolete | [obsolete](https://github.com/matrix-org/matrix-doc/issues?q=label%3Aproposal+label%3Aobsolete+) | A proposal which has been made obsolete by another proposal or decision elsewhere. | +| Proposal Drafting and Feedback | [No label](https://github.com/matrix-org/matrix-spec-proposals/issues?q=label%3Aproposal+-label%3Aabandoned+-label%3Afinal-comment-period+-label%3Afinished-final-comment-period+-label%3Amerged+-label%3Aobsolete+-label%3Aproposal-postponed+-label%3Aproposed-final-comment-period+-label%3Aproposal-in-review+-label%3Aspec-pr-in-review+-label%3Aspec-pr-missing) | A proposal document which is still work-in-progress but is being shared to incorporate feedback. Please prefix your proposal's title with `[WIP]` to make it easier for reviewers to skim their notifications list. | +| Proposal In Review | [proposal-in-review](https://github.com/matrix-org/matrix-spec-proposals/issues?q=label%3Aproposal+label%3Aproposal-in-review) | A proposal document which is now ready and waiting for review by the Spec Core Team and community | +| Proposed Final Comment Period | [proposed-final-comment-period](https://github.com/matrix-org/matrix-spec-proposals/issues?q=label%3Aproposal+label%3Aproposed-final-comment-period+) | Currently awaiting signoff of a 75% majority of team members in order to enter the final comment period | +| Final Comment Period | [final-comment-period](https://github.com/matrix-org/matrix-spec-proposals/issues?q=label%3Aproposal+label%3Afinal-comment-period+) | A proposal document which has reached final comment period either for merge, closure or postponement | +| Final Comment Period Complete | [finished-final-comment-period](https://github.com/matrix-org/matrix-spec-proposals/issues?q=label%3Aproposal+label%3Afinished-final-comment-period+) | The final comment period has been completed. Waiting for a demonstration implementation | +| Spec PR Missing | [spec-pr-missing](https://github.com/matrix-org/matrix-spec-proposals/issues?q=label%3Aproposal+label%3Aspec-pr-missing) | The proposal has been agreed, and proven with a demonstration implementation. Waiting for a PR against the Spec | +| Spec PR In Review | [spec-pr-in-review](https://github.com/matrix-org/matrix-spec-proposals/issues?q=label%3Aproposal+label%3Aspec-pr-in-review+) | The spec PR has been written, and is currently under review | +| Spec PR Merged | [merged](https://github.com/matrix-org/matrix-spec-proposals/issues?q=label%3Aproposal+label%3Amerged) | A proposal with a sufficient working implementation and whose Spec PR has been merged! | +| Postponed | [proposal-postponed](https://github.com/matrix-org/matrix-spec-proposals/issues?q=label%3Aproposal+label%3Aproposal-postponed+) | A proposal that is temporarily blocked or a feature that may not be useful currently but perhaps sometime in the future | +| Abandoned | [abandoned](https://github.com/matrix-org/matrix-spec-proposals/issues?q=label%3Aproposal+label%3Aabandoned) | A proposal where the author/shepherd is not responsive | +| Obsolete | [obsolete](https://github.com/matrix-org/matrix-spec-proposals/issues?q=label%3Aproposal+label%3Aobsolete+) | A proposal which has been made obsolete by another proposal or decision elsewhere. | ## Categories @@ -488,19 +488,19 @@ In summary: This is a living document generated from the list of proposals on the issue and pull request trackers of the -[matrix-doc](https://github.com/matrix-org/matrix-doc) repo. +[matrix-spec-proposals](https://github.com/matrix-org/matrix-spec-proposals) repo. We use labels and some metadata in MSC PR descriptions to generate this page. Labels are assigned by the Spec Core Team whilst triaging the proposals based on those which exist in the -[matrix-doc](https://github.com/matrix-org/matrix-doc) repo already. +[matrix-spec-proposals](https://github.com/matrix-org/matrix-spec-proposals) repo already. It is worth mentioning that a previous version of the MSC process used a mixture of GitHub issues and PRs, leading to some MSC numbers deriving from GitHub issue IDs instead. A useful feature of GitHub is that it does automatically resolve to an issue, if an issue ID is placed in a pull URL. This means that - will correctly + will correctly resolve to the desired MSC, whether it started as an issue or a PR. Other metadata: diff --git a/content/server-server-api.md b/content/server-server-api.md index 0ce07577..cf4b9502 100644 --- a/content/server-server-api.md +++ b/content/server-server-api.md @@ -1251,5 +1251,5 @@ When a domain's ownership changes, the new controller of the domain can masquerade as the previous owner, receiving messages (similarly to email) and request past messages from other servers. In the future, proposals like -[MSC1228](https://github.com/matrix-org/matrix-doc/issues/1228) will +[MSC1228](https://github.com/matrix-org/matrix-spec-proposals/issues/1228) will address this issue. diff --git a/data/api/client-server/definitions/sso_login_flow.yaml b/data/api/client-server/definitions/sso_login_flow.yaml index 464a5f89..82b0cade 100644 --- a/data/api/client-server/definitions/sso_login_flow.yaml +++ b/data/api/client-server/definitions/sso_login_flow.yaml @@ -62,7 +62,7 @@ properties: description: |- Optional UI hint for what kind of common SSO provider is being described in this IdP. Matrix maintains a registry of identifiers - [in the matrix-doc repo](https://github.com/matrix-org/matrix-doc/blob/master/informal/idp-brands.md) + [in the matrix-spec repo](https://github.com/matrix-org/matrix-spec/blob/main/informal/idp-brands.md) to ensure clients and servers are aligned on major/common brands. Clients should prefer the `brand` over the `icon`, when both are diff --git a/informal/idp-brands.md b/informal/idp-brands.md index 24f91811..824be4be 100644 --- a/informal/idp-brands.md +++ b/informal/idp-brands.md @@ -6,7 +6,7 @@ with the relevant additions (using the existing specification as reference) - an required. Once opened, mention your PR in [#sct-office:matrix.org](https://matrix.to/#/#sct-office:matrix.org) on Matrix so it doesn't end up lost. -Please also take some time to read the [contributing guidelines](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst) +Please also take some time to read the [contributing guidelines](https://github.com/matrix-org/matrix-spec/blob/master/CONTRIBUTING.rst) for an overview of PR requirements.