Skip to content

Commit f662782

Browse files
committed
format for git
Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
1 parent b2518c2 commit f662782

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

content/homeserver/features.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,19 @@ weight = 40
88
The matrix.org homeserver is a public Matrix online service that can be used by anyone to interact with the public Matrix federation.
99
It is provided by [Element Creations Ltd](https://element.io) on behalf of The Matrix.org Foundation and consists of multiple software components.
1010

11-
[Synapse](https://github.com/element-hq/synapse)/[Synapse Pro](https://element.io/server-suite/synapse-pro), [Sydent](https://github.com/element-hq/sydent) and [MAS](https://github.com/element-hq/matrix-authentication-service) implement the APIs described by the [Matrix Specification](https://spec.matrix.org). Changes to the spec can be proposed by using the [MSC process](https://github.com/matrix-org/matrix-spec-proposals#summary-of-the-process). (There are also implementation-specific APIs not in the spec, mostly [admin APIs](https://matrix-org.github.io/synapse/develop/usage/administration/admin_api/index.html), which are *not* subject to this policy.)
11+
[Synapse](https://github.com/element-hq/synapse)/[Synapse Pro](https://element.io/server-suite/synapse-pro), [Sydent](https://github.com/element-hq/sydent) and [MAS](https://github.com/element-hq/matrix-authentication-service) implement the APIs described by the [Matrix Specification](https://spec.matrix.org).
12+
Changes to the spec can be proposed by using the [MSC process](https://github.com/matrix-org/matrix-spec-proposals#summary-of-the-process).
13+
(There are also implementation-specific APIs not in the spec, mostly [admin APIs](https://matrix-org.github.io/synapse/develop/usage/administration/admin_api/index.html), which are *not* subject to this policy.)
1214

13-
Often there is a need to [evaluate changes before an MSC is accepted](https://spec.matrix.org/proposals/#early-release-of-an-mscidea), to ensure that they will work in practice with a good user experience. We refer to such changes as *experimental features*. This page discusses the policy for enabling experimental features on the matrix.org homeserver.
15+
Often there is a need to [evaluate changes before an MSC is accepted](https://spec.matrix.org/proposals/#early-release-of-an-mscidea), to ensure that they will work in practice with a good user experience. We refer to such changes as *experimental features*.
16+
This page discusses the policy for enabling experimental features on the matrix.org homeserver.
1417

1518
## Feature Flags
1619

1720
One way to evaluate experimental features is via a feature branch, but long-lived branches are difficult to manage, so a preferable solution is often to merge it to the project's development mainline, but leave it **disabled by default**.
1821

19-
Element's Backend team is normally happy to accept pull requests for experimental features behind a configuration flag, so long as the changes meet the code quality standards and the feature is in active development. (Though note that the team may have to remove experimental features at short notice if they are causing problems.)
22+
Element's Backend team is normally happy to accept pull requests for experimental features behind a configuration flag, so long as the changes meet the code quality standards and the feature is in active development.
23+
(Though note that the team may have to remove experimental features at short notice if they are causing problems.)
2024

2125
Once the feature is available in mainline, it can be enabled on individual servers for testing and evaluation.
2226

@@ -26,15 +30,21 @@ Depending on the feature, it may also be possible to enable it for *specific use
2630

2731
If we're not getting enough traction on development servers, we may want to consider rolling it out further.
2832

29-
It's worth remembering at this point that, whatever happens to an experimental feature, further changes *will* be needed. Hopefully the feature will be a great success, in which case we'll need to standardise the API and replace the `/unstable` endpoints with stable ones. Alternatively, we'll need to iterate on the feature, or, in the worst case, remove it altogether.
33+
It's worth remembering at this point that, whatever happens to an experimental feature, further changes *will* be needed.
34+
Hopefully the feature will be a great success, in which case we'll need to standardise the API and replace the `/unstable` endpoints with stable ones.
35+
Alternatively, we'll need to iterate on the feature, or, in the worst case, remove it altogether.
3036

3137
Experience shows that once we've enabled an experimental feature on a server as widely-used as `matrix.org`, clients and users come to rely on the changes (even when care is taken to avoid doing so). This then makes it very hard to make further changes to the feature — *including replacing the experimental version with a stable one once development is completed* — due to the risk of breaking clients.
3238

33-
In general therefore, it's much preferred to do the bulk of testing on non–`matrix.org` servers. Both `beta.matrix.org` (for public testing) and internal servers are good candidates for doing so. This helps avoid many of the above issues. (TODO See [more on beta.matrix](https://handbook.element.io/new-vector/internal/-/wikis/Beta.matrix.org).)
39+
In general therefore, it's much preferred to do the bulk of testing on non–`matrix.org` servers.
40+
Both `beta.matrix.org` (for public testing) and internal servers are good candidates for doing so.
41+
This helps avoid many of the above issues.
42+
(TODO See [more on beta.matrix](https://handbook.element.io/new-vector/internal/-/wikis/Beta.matrix.org).)
3443

3544
If, having considered the risks, we still want to roll out the feature further, the next step might be to roll it out to a larger subset of users on `matrix.org`, e.g. as part of a community testing initiative.
3645

37-
Enabling the feature for *all* users on `matrix.org` is a last resort. When doing this we'll need to make sure we consider up-front things like:
46+
Enabling the feature for *all* users on `matrix.org` is a last resort.
47+
When doing this we'll need to make sure we consider up-front things like:
3848

3949
- how we make sure that clients don't end up relying on it by accident (for example, guarding it by a 'labs' flag which users have to enable explictly).
4050
- how we will safely evolve the feature if it turns out more changes are needed to the API.
@@ -46,12 +56,17 @@ We'll generally want to have a written document addressing these concerns, to ma
4656

4757
The final step in rolling out a feature is to turn it on everywhere — in other words, to enable it by default in Synapse mainline.
4858

49-
The potential costs of rolling out an experimental feature to the ecosystem as a whole are obviously even higher than turning it on on `matrix.org`. In general, once a feature gets to this stage, we're essentially saying it needs to become part of the standardised Matrix Spec.
59+
The potential costs of rolling out an experimental feature to the ecosystem as a whole are obviously even higher than turning it on on `matrix.org`.
60+
In general, once a feature gets to this stage, we're essentially saying it needs to become part of the standardised Matrix Spec.
5061

51-
In other words: enabling experimental features by default isn't something we would normally do. Instead, the feature should complete the MSC process, thus transforming it into a stable feature.
62+
In other words: enabling experimental features by default isn't something we would normally do.
63+
Instead, the feature should complete the MSC process, thus transforming it into a stable feature.
5264

5365
## Summary
5466

55-
Experimental features should first be tested using a server other than `matrix.org` (e.g. a development or internal server, or `beta.matrix.org`). If further testing is required then it can be enabled for specific users on `matrix.org` (this may not be feasible for all features). Finally, if there is a strong need to test against a large corpus of users then it can be enabled for all `matrix.org` users (for a limited period), subject to certain conditions.
67+
Experimental features should first be tested using a server other than `matrix.org` (e.g. a development or internal server, or `beta.matrix.org`).
68+
If further testing is required then it can be enabled for specific users on `matrix.org` (this may not be feasible for all features).
69+
Finally, if there is a strong need to test against a large corpus of users then it can be enabled for all `matrix.org` users (for a limited period), subject to certain conditions.
5670

57-
Normally experimental features will not be enabled by default within Synapse. To roll out a feature widely, it should go through the MSC process.
71+
Normally experimental features will not be enabled by default within Synapse.
72+
To roll out a feature widely, it should go through the MSC process.

0 commit comments

Comments
 (0)