mirror of
https://github.com/vector-im/element-web.git
synced 2024-09-10 07:05:14 +00:00
Merge pull request #15325 from resynth1943/patch-3
Update Riot -> Element in docs/feature-flags.md
This commit is contained in:
commit
4753a49819
1 changed files with 12 additions and 12 deletions
|
@ -8,7 +8,7 @@ For example, flags make the following things possible:
|
||||||
* Extended testing of a feature via labs on develop
|
* Extended testing of a feature via labs on develop
|
||||||
* Enabling features when ready instead of the first moment the code is released
|
* Enabling features when ready instead of the first moment the code is released
|
||||||
* Testing a feature with a specific set of users (by enabling only on a specific
|
* Testing a feature with a specific set of users (by enabling only on a specific
|
||||||
Riot instance)
|
Element instance)
|
||||||
|
|
||||||
The size of the feature controlled by a feature flag may vary widely: it could
|
The size of the feature controlled by a feature flag may vary widely: it could
|
||||||
be a large project like reactions or a smaller change to an existing algorithm.
|
be a large project like reactions or a smaller change to an existing algorithm.
|
||||||
|
@ -49,7 +49,7 @@ When starting work on a feature, we should create a matching feature flag:
|
||||||
```js
|
```js
|
||||||
SettingsStore.getValue("feature_cats")
|
SettingsStore.getValue("feature_cats")
|
||||||
```
|
```
|
||||||
3. Document the feature in the [labs documentation](https://github.com/vector-im/riot-web/blob/develop/docs/labs.md)
|
3. Document the feature in the [labs documentation](https://github.com/vector-im/element-web/blob/develop/docs/labs.md)
|
||||||
|
|
||||||
With these steps completed, the feature is disabled by default, but can be
|
With these steps completed, the feature is disabled by default, but can be
|
||||||
enabled on develop and nightly by interested users for testing.
|
enabled on develop and nightly by interested users for testing.
|
||||||
|
@ -60,9 +60,9 @@ The following lists a few common options.
|
||||||
## Enabling by default on develop and nightly
|
## Enabling by default on develop and nightly
|
||||||
|
|
||||||
Set the feature to `true` in the
|
Set the feature to `true` in the
|
||||||
[develop](https://github.com/vector-im/riot-web/blob/develop/riot.im/develop/config.json)
|
[develop](https://github.com/vector-im/element-web/blob/develop/element.io/develop/config.json)
|
||||||
and
|
and
|
||||||
[nightly](https://github.com/vector-im/riot-desktop/blob/develop/riot.im/nightly/config.json)
|
[nightly](https://github.com/vector-im/element-desktop/blob/develop/element.io/nightly/config.json)
|
||||||
configs:
|
configs:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
|
@ -74,9 +74,9 @@ configs:
|
||||||
## Enabling by default on staging, app, and release
|
## Enabling by default on staging, app, and release
|
||||||
|
|
||||||
Set the feature to `true` in the
|
Set the feature to `true` in the
|
||||||
[staging / app](https://github.com/vector-im/riot-web/blob/develop/riot.im/app/config.json)
|
[staging / app](https://github.com/vector-im/element-web/blob/develop/element.io/app/config.json)
|
||||||
and
|
and
|
||||||
[release](https://github.com/vector-im/riot-desktop/blob/develop/riot.im/release/config.json)
|
[release](https://github.com/vector-im/element-desktop/blob/develop/element.io/release/config.json)
|
||||||
configs.
|
configs.
|
||||||
|
|
||||||
**Note:** The above will only enable the feature for https://app.element.io and official Element
|
**Note:** The above will only enable the feature for https://app.element.io and official Element
|
||||||
|
@ -90,18 +90,18 @@ Once we're confident that a feature is working well, we should remove or convert
|
||||||
If the feature is meant to be turned off/on by the user:
|
If the feature is meant to be turned off/on by the user:
|
||||||
1. Remove `isFeature` from the [setting](https://github.com/matrix-org/matrix-react-sdk/blob/develop/src/settings/Settings.ts)
|
1. Remove `isFeature` from the [setting](https://github.com/matrix-org/matrix-react-sdk/blob/develop/src/settings/Settings.ts)
|
||||||
2. Change the `default` to `true` (if desired).
|
2. Change the `default` to `true` (if desired).
|
||||||
3. Remove the feature from the [labs documentation](https://github.com/vector-im/riot-web/blob/develop/docs/labs.md)
|
3. Remove the feature from the [labs documentation](https://github.com/vector-im/element-web/blob/develop/docs/labs.md)
|
||||||
4. Celebrate! 🥳
|
4. Celebrate! 🥳
|
||||||
|
|
||||||
If the feature is meant to be forced on (non-configurable):
|
If the feature is meant to be forced on (non-configurable):
|
||||||
1. Remove the [setting](https://github.com/matrix-org/matrix-react-sdk/blob/develop/src/settings/Settings.ts)
|
1. Remove the [setting](https://github.com/matrix-org/matrix-react-sdk/blob/develop/src/settings/Settings.ts)
|
||||||
2. Remove all `getValue` lines that test for the feature.
|
2. Remove all `getValue` lines that test for the feature.
|
||||||
3. Remove the feature from the [labs documentation](https://github.com/vector-im/riot-web/blob/develop/docs/labs.md)
|
3. Remove the feature from the [labs documentation](https://github.com/vector-im/element-web/blob/develop/docs/labs.md)
|
||||||
4. If applicable, remove the feature state from
|
4. If applicable, remove the feature state from
|
||||||
[develop](https://github.com/vector-im/riot-web/blob/develop/riot.im/develop/config.json),
|
[develop](https://github.com/vector-im/element-web/blob/develop/element.io/develop/config.json),
|
||||||
[nightly](https://github.com/vector-im/riot-desktop/blob/develop/riot.im/nightly/config.json),
|
[nightly](https://github.com/vector-im/element-desktop/blob/develop/element.io/nightly/config.json),
|
||||||
[staging / app](https://github.com/vector-im/riot-web/blob/develop/riot.im/app/config.json),
|
[staging / app](https://github.com/vector-im/element-web/blob/develop/element.io/app/config.json),
|
||||||
and
|
and
|
||||||
[release](https://github.com/vector-im/riot-desktop/blob/develop/riot.im/release/config.json)
|
[release](https://github.com/vector-im/element-desktop/blob/develop/element.io/release/config.json)
|
||||||
configs
|
configs
|
||||||
5. Celebrate! 🥳
|
5. Celebrate! 🥳
|
||||||
|
|
Loading…
Reference in a new issue