[DOC] Adding documentation for experiments #7424
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As I'm picking up more of Ember CLI work, I realized we are missing documentation on how experiments work. I synced with @rwjblue offline, and I know the information here isn't fully clear. Would like some help from other contributors.
twokul
requested changes
Nov 7, 2017
docs/experiments.md
Outdated
| feature is disabled. | ||
|
|
||
| ## Supported | ||
| Once an experiment has through the different betas, and we can confidently say |
There was a problem hiding this comment.
are you missing a word here or am I misreading? once an experiment has through what?
rwjblue
reviewed
Nov 7, 2017
docs/experiments.md
Outdated
|
|
||
| ## Unsupported | ||
| The Ember CLI core team will evaluate each experiment before betas get released. | ||
| If the experiment is not ready, experiment is deleted from the codebase. |
There was a problem hiding this comment.
I would rephrase this to:
If the experiment is not ready, the entry for the experiment is deleted from
lib/experiments/index.js.
There was a problem hiding this comment.
Ah. I was trying to refrain from mentioning the file since the location of it can change, but this is more clear 👍
docs/experiments.md
Outdated
| ## Supported | ||
| Once an experiment has gone through the different stages of beta, and we can | ||
| confidently say a specific feature from an experiment will be supported, we | ||
| delete the exerpiemnt from the codebase. |
There was a problem hiding this comment.
I would tweak the verbiage to:
confidently say a specific feature from an experiment will be supported, we delete the entry in
lib/experiments/index.jsand remove the experiment guards (e.g.if (experiments.FOO_BAR) {) from the codebase.
twokul
approved these changes
Nov 8, 2017
|
Thanks @sangm! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As I'm picking up more of Ember CLI work, I realized we are missing
documentation on how experiments work.
I synced with @rwjblue offline, and I know the information here isn't fully
clear. Would like some help from other contributors.