From 4416a23e55fd248bcd3d0f300a56a693145da7d5 Mon Sep 17 00:00:00 2001 From: Sara Cope Date: Thu, 10 Oct 2024 09:28:37 -0400 Subject: [PATCH 1/3] Update master branch to main --- guides/release/configuring-ember/feature-flags.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/guides/release/configuring-ember/feature-flags.md b/guides/release/configuring-ember/feature-flags.md index 3b618511b0..2aba4628a3 100644 --- a/guides/release/configuring-ember/feature-flags.md +++ b/guides/release/configuring-ember/feature-flags.md @@ -21,7 +21,7 @@ were enabled during the beta cycle. At this point the feature flags will be remo the canary and future beta branches, and the feature becomes part of the framework. ## Flagging Details -The flag status in the generated build is controlled by the [`@ember/canary-features`](https://github.com/emberjs/ember.js/blob/master/packages/@ember/canary-features/index.ts) +The flag status in the generated build is controlled by the [`@ember/canary-features`](https://github.com/emberjs/ember.js/blob/main/packages/@ember/canary-features/index.ts) package. This package exports a list of all available features and their current status. A feature can have one of a three flags: @@ -36,10 +36,10 @@ A feature can have one of a three flags: The process of removing the feature flags from the resulting build output is handled by [`defeatureify`](https://github.com/thomasboyt/defeatureify). -## Feature Listing ([`FEATURES.md`](https://github.com/emberjs/ember.js/blob/master/FEATURES.md)) +## Feature Listing ([`FEATURES.md`](https://github.com/emberjs/ember.js/blob/main/FEATURES.md)) -When a developer adds a new feature to the `canary` channel (i.e. the `master` branch on GitHub), they -also add an entry to [`FEATURES.md`](https://github.com/emberjs/ember.js/blob/master/FEATURES.md) +When a developer adds a new feature to the `canary` channel (i.e. the `main` branch on GitHub), they +also add an entry to [`FEATURES.md`](https://github.com/emberjs/ember.js/blob/main/FEATURES.md) explaining what the feature does, and linking to their originating pull request. This list is kept current, and reflects what is available in each channel (`release`, `beta`, and `canary`). From 3e76474b7e5797de8498c8dc3bacaa194694158d Mon Sep 17 00:00:00 2001 From: Sara Cope Date: Thu, 10 Oct 2024 09:29:43 -0400 Subject: [PATCH 2/3] Fixes for grammar --- guides/release/configuring-ember/feature-flags.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/guides/release/configuring-ember/feature-flags.md b/guides/release/configuring-ember/feature-flags.md index 2aba4628a3..604f6b764a 100644 --- a/guides/release/configuring-ember/feature-flags.md +++ b/guides/release/configuring-ember/feature-flags.md @@ -9,22 +9,22 @@ Ember.js community considers them ready for production use. A newly-flagged feature is only available in canary builds and can be enabled at runtime through your project's configuration file. -At the start of a beta cycle the Ember core team evaluates each new feature. +At the start of a beta cycle, the Ember core team evaluates each new feature. Features deemed stable are made available in the next beta and enabled by default. Beta features that receive negative feedback from the community are disabled in the next beta point -release, and are not included in the next stable release. They may still be included +release and are not included in the next stable release. They may still be included in the next beta cycle if the issues/concerns are resolved. -Once the beta cycle has completed, the next stable release will include any features that -were enabled during the beta cycle. At this point the feature flags will be removed from +Once the beta cycle has been completed, the next stable release will include any features that +were enabled during the beta cycle. At this point, the feature flags will be removed from the canary and future beta branches, and the feature becomes part of the framework. ## Flagging Details The flag status in the generated build is controlled by the [`@ember/canary-features`](https://github.com/emberjs/ember.js/blob/main/packages/@ember/canary-features/index.ts) package. This package exports a list of all available features and their current status. -A feature can have one of a three flags: +A feature can have one of three flags: * `true` - The feature is **present** and **enabled**: the code behind the flag is always enabled in the generated build. @@ -41,7 +41,7 @@ handled by [`defeatureify`](https://github.com/thomasboyt/defeatureify). When a developer adds a new feature to the `canary` channel (i.e. the `main` branch on GitHub), they also add an entry to [`FEATURES.md`](https://github.com/emberjs/ember.js/blob/main/FEATURES.md) explaining what the feature does, and linking to their originating pull request. -This list is kept current, and reflects what is available in each channel +This list is kept current and reflects what is available in each channel (`release`, `beta`, and `canary`). ## Enabling At Runtime From 97b6846d781c6d347b63867e83b07d3fcabbff42 Mon Sep 17 00:00:00 2001 From: Sara Cope Date: Thu, 10 Oct 2024 09:35:56 -0400 Subject: [PATCH 3/3] Update feature key example - closes #453 --- guides/release/configuring-ember/feature-flags.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/release/configuring-ember/feature-flags.md b/guides/release/configuring-ember/feature-flags.md index 604f6b764a..af8f2fda24 100644 --- a/guides/release/configuring-ember/feature-flags.md +++ b/guides/release/configuring-ember/feature-flags.md @@ -52,7 +52,7 @@ feature by setting its flag value to `true` before your application boots: let ENV = { EmberENV: { FEATURES: { - 'link-to': true + 'LINK_TO': true } } };