Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links to matrix-doc #1032

Merged
merged 2 commits into from Apr 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 0 additions & 19 deletions .github/PULL_REQUEST_TEMPLATE/ready-proposal.md

This file was deleted.

6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE/spec-change.md
Expand Up @@ -11,6 +11,6 @@ assignees: ''

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

* [ ] 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)
20 changes: 0 additions & 20 deletions .github/PULL_REQUEST_TEMPLATE/wip-proposal.md

This file was deleted.

35 changes: 14 additions & 21 deletions CONTRIBUTING.rst
@@ -1,5 +1,5 @@
Contributing to matrix-doc
==========================
Contributing to matrix-spec
===========================

Everyone is welcome to contribute to the Matrix specification!

Expand All @@ -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.
Comment on lines -14 to -16
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this was a bit of a dead link, and we don't really have any python code here any more.


Matrix-doc workflows
Matrix-spec workflows
--------------------

Specification changes
Expand All @@ -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 <https://matrix.org/docs/spec/proposals>`_. 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 <https://matrix.org/docs/spec/proposals>`_.

Other changes
~~~~~~~~~~~~~
Expand All @@ -42,20 +36,20 @@ 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
<https://github.com/matrix-org/matrix-doc/labels/spec-omission>`_ label).
<https://github.com/matrix-org/matrix-spec/labels/spec-omission>`_ 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
<https://github.com/matrix-org/matrix-doc/labels/spec-bug>`_ label.
<https://github.com/matrix-org/matrix-spec/labels/spec-bug>`_ 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`_.)

* 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 <https://github.com/matrix-org/matrix-doc/labels/clarification>`_
`clarification <https://github.com/matrix-org/matrix-spec/labels/clarification>`_
label.

For example, areas where the specification is unclear do not require a proposal
Expand All @@ -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 <https://github.com/twisted/towncrier>`_ in the
form of "news fragments". The news fragments for the client-server API are stored
under ``changelogs/client_server/newsfragments``.

Expand Down Expand Up @@ -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
Expand All @@ -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 <https://www.kernel.org/doc/html/latest/process/submitting-patches.html>`_,
`Docker <https://github.com/docker/docker/blob/master/CONTRIBUTING.md`_, and many other
projects: the `Developer Certificate of Origin <http://developercertificate.org/>`_
(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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -98,6 +98,6 @@ there are a number of options:

## Issue tracking

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

See [meta/github-labels.rst](./meta/github-labels.rst) for information on what the labels mean.
@@ -0,0 +1 @@
Update various links which pointed to the old `matrix-doc` github repository.
2 changes: 1 addition & 1 deletion changelogs/header.md
Expand Up @@ -9,7 +9,7 @@ Variables:
## VERSION

<table class="release-info">
<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>
<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>
</table>

Expand Down
2 changes: 1 addition & 1 deletion 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

Expand Down
@@ -0,0 +1 @@
Update various links which pointed to the old `matrix-doc` github repository.
2 changes: 1 addition & 1 deletion content/_index.md
Expand Up @@ -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 %}}

Expand Down
6 changes: 3 additions & 3 deletions content/appendices.md
Expand Up @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/identity-service-api.md
Expand Up @@ -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.
Expand Down