Skip to content

Commit

Permalink
Variable Status Docs (#493)
Browse files Browse the repository at this point in the history
* Variable Status Docs

Added note for Variable Status in Variables Documentation

* Update docs/essentials/variables.md

Co-authored-by: Nikolas LeBlanc <nikolas.leblanc@gmail.com>

* Update docs/essentials/variables.md

Co-authored-by: Nikolas LeBlanc <nikolas.leblanc@gmail.com>

* Update docs/essentials/variables.md

Co-authored-by: Nikolas LeBlanc <nikolas.leblanc@gmail.com>

---------

Co-authored-by: Nikolas LeBlanc <nikolas.leblanc@gmail.com>
  • Loading branch information
katemacfarlane and nikolasleblanc authored Dec 4, 2023
1 parent 2f2f960 commit 4c4f5cc
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/essentials/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,18 @@ To view the Variables and Variations within a Feature, navigate to the 'Variable

Each Feature manages its own set of Variables. **By default, upon creation of a Feature, a Boolean Variable will be created which has the same name as the Feature's key for easier reference.**

Depending on the Feature type, the default Variations will be pre-set. The most common of which will be the Variations of "Variation OFF" and "Variation ON", with the boolean Variable being set to false and true, respectively.
On the Feature page, there are indicators for each Variable that inform you of the following:

- if a Variable has been seen in code (if [Code References](/integrations/github/feature-usage-action) have been enabled)
- if evaluations have been seen

These indicators are helpful when setting up features. They help to confirm proper setup, and aid in Variable cleanup once a Feature has completed it's [lifecycle](/essentials/status-and-lifecycle).

Hover over these indicators for more detail about a Variable's code references & evaluation information.

![Variable Status Indicator](/nov-2023-var-status-found-eval-rec.png)

Depending on the Feature type, the default Variations will be pre-set. For example, the most common feature type is a Release Flag, and it will have two variations - "Variation OFF" and "Variation ON", with the boolean Variable being set to false and true, respectively.

:::info
For more information on variations please visit the [variations section](/essentials/variations) of the documentation.
Expand Down
Binary file added static/nov-2023-var-status-found-eval-rec.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/nov-2023-var-status-ind.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 4c4f5cc

@vercel
Copy link

@vercel vercel bot commented on 4c4f5cc Dec 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.