From 407777539fc0a4f87c23d835fcfd8d38473b4652 Mon Sep 17 00:00:00 2001 From: Qt Resynth Date: Wed, 30 Sep 2020 11:00:02 +0000 Subject: [PATCH 1/3] Moar Element 'n' Stuff Gotta fix that up :-) Man this is how I spend my free time --- docs/feature-flags.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/feature-flags.md b/docs/feature-flags.md index 5fb5545fdf..effd3b30f3 100644 --- a/docs/feature-flags.md +++ b/docs/feature-flags.md @@ -49,7 +49,7 @@ When starting work on a feature, we should create a matching feature flag: ```js 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 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 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 -[nightly](https://github.com/vector-im/riot-desktop/blob/develop/riot.im/nightly/config.json) +[nightly](https://github.com/vector-im/element-web/blob/develop/element.io/nightly/config.json) configs: ```json @@ -74,9 +74,9 @@ configs: ## Enabling by default on staging, app, and release 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 -[release](https://github.com/vector-im/riot-desktop/blob/develop/riot.im/release/config.json) +[release](https://github.com/vector-im/element-web/blob/develop/element.io/release/config.json) configs. **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: 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). -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! 🥳 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) 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 - [develop](https://github.com/vector-im/riot-web/blob/develop/riot.im/develop/config.json), - [nightly](https://github.com/vector-im/riot-desktop/blob/develop/riot.im/nightly/config.json), - [staging / app](https://github.com/vector-im/riot-web/blob/develop/riot.im/app/config.json), + [develop](https://github.com/vector-im/element-web/blob/develop/element.io/develop/config.json), + [nightly](https://github.com/vector-im/element-desktop/blob/develop/element.io/nightly/config.json), + [staging / app](https://github.com/vector-im/element-web/blob/develop/element.io/app/config.json), 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 5. Celebrate! 🥳 From 48f71f26e7b5c2da3822a1549d321c5842861be4 Mon Sep 17 00:00:00 2001 From: Qt Resynth Date: Wed, 30 Sep 2020 11:58:44 +0000 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: J. Ryan Stinnett --- docs/feature-flags.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/feature-flags.md b/docs/feature-flags.md index effd3b30f3..dbd9707f06 100644 --- a/docs/feature-flags.md +++ b/docs/feature-flags.md @@ -62,7 +62,7 @@ The following lists a few common options. Set the feature to `true` in the [develop](https://github.com/vector-im/element-web/blob/develop/element.io/develop/config.json) and -[nightly](https://github.com/vector-im/element-web/blob/develop/element.io/nightly/config.json) +[nightly](https://github.com/vector-im/element-desktop/blob/develop/element.io/nightly/config.json) configs: ```json @@ -76,7 +76,7 @@ configs: Set the feature to `true` in the [staging / app](https://github.com/vector-im/element-web/blob/develop/element.io/app/config.json) and -[release](https://github.com/vector-im/element-web/blob/develop/element.io/release/config.json) +[release](https://github.com/vector-im/element-desktop/blob/develop/element.io/release/config.json) configs. **Note:** The above will only enable the feature for https://app.element.io and official Element From db08128954d145742db60616cd613d7892ffebff Mon Sep 17 00:00:00 2001 From: Qt Resynth Date: Wed, 30 Sep 2020 12:04:01 +0000 Subject: [PATCH 3/3] Riot -> Element --- docs/feature-flags.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/feature-flags.md b/docs/feature-flags.md index dbd9707f06..1e7e5cce37 100644 --- a/docs/feature-flags.md +++ b/docs/feature-flags.md @@ -8,7 +8,7 @@ For example, flags make the following things possible: * Extended testing of a feature via labs on develop * 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 - Riot instance) + Element instance) 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.