Skip to content

Commit

Permalink
docs: DOC-220: Remove FF references from docs (#5984)
Browse files Browse the repository at this point in the history
Removing feature flag references from docs. 



#### Affects

- [X] Community docs
- [X] Enterprise docs

---------

Co-authored-by: caitlinwheeless <caitlin@humansignal.com>
Co-authored-by: farioas <farioas@users.noreply.github.com>
Co-authored-by: robot-ci-heartex <robot-ci-heartex@users.noreply.github.com>
  • Loading branch information
4 people committed Jun 13, 2024
1 parent dd900c4 commit 5de6080
Show file tree
Hide file tree
Showing 22 changed files with 32 additions and 95 deletions.
13 changes: 0 additions & 13 deletions docs/source/guide/helm_values.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,16 +310,3 @@ global:
If you are deploying to a production environment, you should set `SSRF_PROTECTION_ENABLED: true`. See [Secure Label Studio](security#Enable-SSRF-protection-for-production-environments).


## The `global.featureFlags` usage

The `global.featureFlags` section can be used to set feature flags of Label Studio.

Any key value put under this section translates to environment variables used to control Label Studio's feature flags configuration. Every key should start from `ff_` or `fflag_` in lower case.

An example:

```yaml
global:
featureFlags:
fflag_enable_some_cool_feature_short: true
```
4 changes: 1 addition & 3 deletions docs/source/tags/choice.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ meta_description: Customize Label Studio with choice tags for simple classificat

The `Choice` tag represents a single choice for annotations. Use with the `Choices` tag or `Taxonomy` tag to provide specific choice options.

[^1]: The `hint` attribute works only when `fflag_feat_front_prod_309_choice_hint_080523_short` is enabled

### Parameters

| Param | Type | Description |
Expand All @@ -20,7 +18,7 @@ The `Choice` tag represents a single choice for annotations. Use with the `Choic
| [style] | <code>style</code> | CSS style of the checkbox element |
| [hotkey] | <code>string</code> | Hotkey for the selection |
| [html] | <code>string</code> | Can be used to show enriched content, it has higher priority than `value`, however `value` will be used in the exported result (should be properly escaped) |
| [hint] | <code>string</code> | Hint for choice on hover[^1] |
| [hint] | <code>string</code> | Hint for choice on hover |
| [color] | <code>string</code> | Color for Taxonomy item |

### Example
Expand Down
4 changes: 1 addition & 3 deletions docs/source/tags/choices.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ Choices can have dynamic value to load labels from task. This task data should c

The `Choices` tag can be used with any data types.

[^1]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality.

### Parameters

| Param | Type | Default | Description |
Expand All @@ -29,7 +27,7 @@ The `Choices` tag can be used with any data types.
| [whenLabelValue] | <code>string</code> | | Use with visibleWhen="region-selected". Narrow down visibility by label value |
| [whenChoiceValue] | <code>string</code> | | Use with visibleWhen ("choice-selected" or "choice-unselected") and whenTagName, both are required. Narrow down visibility by choice value |
| [perRegion] | <code>boolean</code> | | Use this tag to select a choice for a specific region instead of the entire task |
| [perItem] | <code>boolean</code> | | Use this tag to select a choice for a specific item inside the object instead of the whole object[^1] |
| [perItem] | <code>boolean</code> | | Use this tag to select a choice for a specific item inside the object instead of the whole object |
| [value] | <code>string</code> | | Task data field containing a list of dynamically loaded choices (see example below) |
| [allowNested] | <code>boolean</code> | | Allow to use `children` field in dynamic choices to nest them. Submitted result will contain array of arrays, every item is a list of values from topmost parent choice down to selected one. |

Expand Down
4 changes: 1 addition & 3 deletions docs/source/tags/datetime.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ The DateTime tag adds date and time selection to the labeling interface. Use thi

Use with the following data types: audio, image, HTML, paragraph, text, time series, video

[^1]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality

### Parameters

| Param | Type | Default | Description |
Expand All @@ -23,7 +21,7 @@ Use with the following data types: audio, image, HTML, paragraph, text, time ser
| [required] | <code>boolean</code> | <code>false</code> | Whether datetime is required or not |
| [requiredMessage] | <code>string</code> | | Message to show if validation fails |
| [perRegion] | <code>boolean</code> | | Use this option to label regions instead of the whole object |
| [perItem] | <code>boolean</code> | | Use this option to label items inside the object instead of the whole object[^1] |
| [perItem] | <code>boolean</code> | | Use this option to label items inside the object instead of the whole object |

### Example
```html
Expand Down
8 changes: 0 additions & 8 deletions docs/source/tags/magicwand.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,6 @@ Example of the Magic Wand in use:
![Animated GIF showing Magic Wand clicking on cloud and dragging, automatically segmenting and selecting
pixels to create a mask](../images/magicwand_example.gif)

### Feature Flag

The Magic Wand is currently turned off by default behind a feature flag. If you want to turn it on, you
must enable it by either:
- Setting an environment variable when starting the Label Studio server, either by starting up the
server with `fflag_feat_front_dev_4081_magic_wand_tool=1 label-studio`, or manually finding the flag
`flag_feat_front_dev_4081_magic_wand_tool` and setting it to true.

### CORS Configuration

The Magic Wand requires pixel-level access to images that are being labelled in order to do its
Expand Down
4 changes: 1 addition & 3 deletions docs/source/tags/number.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ The Number tag supports numeric classification. Use to classify tasks using numb

Use with the following data types: audio, image, HTML, paragraphs, text, time series, video

[^1]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality

### Parameters

| Param | Type | Default | Description |
Expand All @@ -26,7 +24,7 @@ Use with the following data types: audio, image, HTML, paragraphs, text, time se
| [required] | <code>boolean</code> | <code>false</code> | Whether number is required or not |
| [requiredMessage] | <code>string</code> | | Message to show if validation fails |
| [perRegion] | <code>boolean</code> | | Use this tag to classify specific regions instead of the whole object |
| [perItem] | <code>boolean</code> | | Use this tag to classify specific items inside the object instead of the whole object[^1] |
| [perItem] | <code>boolean</code> | | Use this tag to classify specific items inside the object instead of the whole object |
| [slider] | <code>boolean</code> | <code>false</code> | Use slider look instead of input; use min and max to add your constraints |

### Example
Expand Down
4 changes: 1 addition & 3 deletions docs/source/tags/rating.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ The `Rating` tag adds a rating selection to the labeling interface. Use for labe

Use with the following data types: audio, image, HTML, paragraphs, text, time series, video.

[^1]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality

### Parameters

| Param | Type | Default | Description |
Expand All @@ -26,7 +24,7 @@ Use with the following data types: audio, image, HTML, paragraphs, text, time se
| [required] | <code>boolean</code> | <code>false</code> | Whether rating validation is required |
| [requiredMessage] | <code>string</code> | | Message to show if validation fails |
| [perRegion] | <code>boolean</code> | | Use this tag to rate regions instead of the whole object |
| [perItem] | <code>boolean</code> | | Use this tag to rate items inside the object instead of the whole object[^1] |
| [perItem] | <code>boolean</code> | | Use this tag to rate items inside the object instead of the whole object |

### Example

Expand Down
4 changes: 1 addition & 3 deletions docs/source/tags/taxonomy.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ You can define nested classifications using the `Choice` tag, or retrieve extern

Use with the following data types: audio, image, HTML, paragraphs, text, time series, video.

[^1]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality

### Parameters

| Param | Type | Default | Description |
Expand All @@ -31,7 +29,7 @@ Use with the following data types: audio, image, HTML, paragraphs, text, time se
| [requiredMessage] | <code>string</code> | | Message to show if validation fails |
| [placeholder=] | <code>string</code> | | What to display as prompt on the input |
| [perRegion] | <code>boolean</code> | | Use this tag to classify specific regions instead of the whole object |
| [perItem] | <code>boolean</code> | | Use this tag to classify specific items inside the object instead of the whole object[^1] |
| [perItem] | <code>boolean</code> | | Use this tag to classify specific items inside the object instead of the whole object |
| [legacy] | <code>boolean</code> | | Use this tag to enable the legacy version of the Taxonomy tag. The legacy version supports the ability for annotators to add labels as needed. However, when true, the `apiUrl` parameter is not usable. |

### Example
Expand Down
12 changes: 3 additions & 9 deletions docs/source/tags/textarea.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@ The `TextArea` tag is used to display a text area for user input. Use for transc

Use with the following data types: audio, image, HTML, paragraphs, text, time series, video.

[^1]: `fflag_feat_front_lsdv_4659_skipduplicates_060323_short` should be enabled to use `skipDuplicates` attribute

[^2]: `fflag_feat_front_lsdv_4712_skipduplicates_editing_110423_short` should be enabled to keep submissions unique during editing existed results

[^3]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality

### Parameters

| Param | Type | Default | Description |
Expand All @@ -27,15 +21,15 @@ Use with the following data types: audio, image, HTML, paragraphs, text, time se
| [placeholder] | <code>string</code> | | Placeholder text |
| [maxSubmissions] | <code>string</code> | | Maximum number of submissions |
| [editable] | <code>boolean</code> | <code>false</code> | Whether to display an editable textarea |
| [skipDuplicates] | <code>boolean</code> | <code>false</code> | Prevent duplicates in textarea inputs[^1][^2] (see example below) |
| [skipDuplicates] | <code>boolean</code> | <code>false</code> | Prevent duplicates in textarea inputs |
| [transcription] | <code>boolean</code> | <code>false</code> | If false, always show editor |
| [displayMode] | <code>tag</code> \| <code>region-list</code> | <code>tag</code> | Display mode for the textarea; region-list shows it for every region in regions list |
| [rows] | <code>number</code> | | Number of rows in the textarea |
| [required] | <code>boolean</code> | <code>false</code> | Validate whether content in textarea is required |
| [requiredMessage] | <code>string</code> | | Message to show if validation fails |
| [showSubmitButton] | <code>boolean</code> | | Whether to show or hide the submit button. By default it shows when there are more than one rows of text, such as in textarea mode. |
| [perRegion] | <code>boolean</code> | | Use this tag to label regions instead of whole objects |
| [perItem] | <code>boolean</code> | | Use this tag to label items inside objects instead of whole objects[^3] |
| [perItem] | <code>boolean</code> | | Use this tag to label items inside objects instead of whole objects |

### Example

Expand Down Expand Up @@ -63,7 +57,7 @@ You can combine the `TextArea` tag with other tags for OCR or other transcriptio
```
### Example

You can keep submissions unique[^1][^2]
You can keep submissions unique.

```html
<View>
Expand Down
8 changes: 4 additions & 4 deletions web/dist/apps/labelstudio/version.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{

Check notice on line 1 in web/dist/apps/labelstudio/version.json

View workflow job for this annotation

GitHub Actions / merge

Merge Conflict automatically resolved web/dist/apps/labelstudio/version.json
"message": "chore: LEAP-1149: bump braces from 3.0.2 to 3.0.3 in /web (#5966)",
"commit": "4bc7cccf37b8e743439a6a8182f63c954bdb4c84",
"date": "2024-06-13T17:44:43.000Z",
"branch": "develop"
"message": "Merge branch 'develop' into 'docs/ff-removal'",
"commit": "40fc0caad154f18e9d8beb627c71debe199cadb6",
"date": "2024-06-13T18:52:15.000Z",
"branch": "docs/ff-removal"
}
8 changes: 4 additions & 4 deletions web/dist/libs/datamanager/version.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{

Check notice on line 1 in web/dist/libs/datamanager/version.json

View workflow job for this annotation

GitHub Actions / merge

Merge Conflict automatically resolved web/dist/libs/datamanager/version.json
"message": "chore: LEAP-1149: bump braces from 3.0.2 to 3.0.3 in /web (#5966)",
"commit": "4bc7cccf37b8e743439a6a8182f63c954bdb4c84",
"date": "2024-06-13T17:44:43.000Z",
"branch": "develop"
"message": "Merge branch 'develop' into 'docs/ff-removal'",
"commit": "40fc0caad154f18e9d8beb627c71debe199cadb6",
"date": "2024-06-13T18:52:15.000Z",
"branch": "docs/ff-removal"
}
2 changes: 1 addition & 1 deletion web/dist/libs/editor/main.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion web/dist/libs/editor/main.js.map

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions web/dist/libs/editor/version.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{

Check notice on line 1 in web/dist/libs/editor/version.json

View workflow job for this annotation

GitHub Actions / merge

Merge Conflict automatically resolved web/dist/libs/editor/version.json
"message": "chore: LEAP-1149: bump braces from 3.0.2 to 3.0.3 in /web (#5966)",
"commit": "4bc7cccf37b8e743439a6a8182f63c954bdb4c84",
"date": "2024-06-13T17:44:43.000Z",
"branch": "develop"
"message": "Merge branch 'develop' into 'docs/ff-removal'",
"commit": "40fc0caad154f18e9d8beb627c71debe199cadb6",
"date": "2024-06-13T18:52:15.000Z",
"branch": "docs/ff-removal"
}
4 changes: 1 addition & 3 deletions web/libs/editor/src/tags/control/Choice.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ import { sanitizeHtml } from "../../utils/html";
/**
* The `Choice` tag represents a single choice for annotations. Use with the `Choices` tag or `Taxonomy` tag to provide specific choice options.
*
* [^FF_PROD_309]: The `hint` attribute works only when `fflag_feat_front_prod_309_choice_hint_080523_short` is enabled
*
* @example
* <!--Basic text classification labeling configuration-->
* <View>
Expand All @@ -44,7 +42,7 @@ import { sanitizeHtml } from "../../utils/html";
* @param {style} [style] - CSS style of the checkbox element
* @param {string} [hotkey] - Hotkey for the selection
* @param {string} [html] - Can be used to show enriched content, it has higher priority than `value`, however `value` will be used in the exported result (should be properly escaped)
* @param {string} [hint] - Hint for choice on hover[^FF_PROD_309]
* @param {string} [hint] - Hint for choice on hover
* @param {string} [color] - Color for Taxonomy item
*/
const TagAttrs = types.model({
Expand Down
4 changes: 1 addition & 3 deletions web/libs/editor/src/tags/control/Choices.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ const { Option } = Select;
*
* The `Choices` tag can be used with any data types.
*
* [^FF_LSDV_4583]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality.
*
* @example
* <!--Basic text classification labeling configuration-->
* <View>
Expand Down Expand Up @@ -94,7 +92,7 @@ const { Option } = Select;
* @param {string} [whenLabelValue] - Use with visibleWhen="region-selected". Narrow down visibility by label value
* @param {string} [whenChoiceValue] - Use with visibleWhen ("choice-selected" or "choice-unselected") and whenTagName, both are required. Narrow down visibility by choice value
* @param {boolean} [perRegion] - Use this tag to select a choice for a specific region instead of the entire task
* @param {boolean} [perItem] - Use this tag to select a choice for a specific item inside the object instead of the whole object[^FF_LSDV_4583]
* @param {boolean} [perItem] - Use this tag to select a choice for a specific item inside the object instead of the whole object
* @param {string} [value] - Task data field containing a list of dynamically loaded choices (see example below)
* @param {boolean} [allowNested] - Allow to use `children` field in dynamic choices to nest them. Submitted result will contain array of arrays, every item is a list of values from topmost parent choice down to selected one.
*/
Expand Down
4 changes: 1 addition & 3 deletions web/libs/editor/src/tags/control/DateTime.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ const zero = (n) => (n < 10 ? "0" : "") + n;
*
* Use with the following data types: audio, image, HTML, paragraph, text, time series, video
*
* [^FF_LSDV_4583]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality
*
* @example
* <View>
* <Text name="txt" value="$text" />
Expand All @@ -51,7 +49,7 @@ const zero = (n) => (n < 10 ? "0" : "") + n;
* @param {boolean} [required=false] - Whether datetime is required or not
* @param {string} [requiredMessage] - Message to show if validation fails
* @param {boolean} [perRegion] - Use this option to label regions instead of the whole object
* @param {boolean} [perItem] - Use this option to label items inside the object instead of the whole object[^FF_LSDV_4583]
* @param {boolean} [perItem] - Use this option to label items inside the object instead of the whole object
*/
const TagAttrs = types.model({
toname: types.maybeNull(types.string),
Expand Down
8 changes: 0 additions & 8 deletions web/libs/editor/src/tags/control/MagicWand.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,6 @@ import { FF_DEV_4081, isFF } from "../../utils/feature-flags";
* ![Animated GIF showing Magic Wand clicking on cloud and dragging, automatically segmenting and selecting
* pixels to create a mask](../images/magicwand_example.gif)
*
* ### Feature Flag
*
* The Magic Wand is currently turned off by default behind a feature flag. If you want to turn it on, you
* must enable it by either:
* - Setting an environment variable when starting the Label Studio server, either by starting up the
* server with `fflag_feat_front_dev_4081_magic_wand_tool=1 label-studio`, or manually finding the flag
* `flag_feat_front_dev_4081_magic_wand_tool` and setting it to true.
*
* ### CORS Configuration
*
* The Magic Wand requires pixel-level access to images that are being labelled in order to do its
Expand Down
4 changes: 1 addition & 3 deletions web/libs/editor/src/tags/control/Number.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ import { FF_LSDV_4583, isFF } from "../../utils/feature-flags";
*
* Use with the following data types: audio, image, HTML, paragraphs, text, time series, video
*
* [^FF_LSDV_4583]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality
*
* @example
* <!--Basic labeling configuration for numeric classification of text -->
* <View>
Expand All @@ -42,7 +40,7 @@ import { FF_LSDV_4583, isFF } from "../../utils/feature-flags";
* @param {boolean} [required=false] - Whether number is required or not
* @param {string} [requiredMessage] - Message to show if validation fails
* @param {boolean} [perRegion] - Use this tag to classify specific regions instead of the whole object
* @param {boolean} [perItem] - Use this tag to classify specific items inside the object instead of the whole object[^FF_LSDV_4583]
* @param {boolean} [perItem] - Use this tag to classify specific items inside the object instead of the whole object
* @param {boolean} [slider=false] - Use slider look instead of input; use min and max to add your constraints
*/
const TagAttrs = types.model({
Expand Down
4 changes: 1 addition & 3 deletions web/libs/editor/src/tags/control/Rating.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ import { FF_LSDV_4583, isFF } from "../../utils/feature-flags";
*
* Use with the following data types: audio, image, HTML, paragraphs, text, time series, video.
*
* [^FF_LSDV_4583]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality
*
* @example
* <!--Basic labeling configuration to rate the content of a text passage -->
* <View>
Expand All @@ -42,7 +40,7 @@ import { FF_LSDV_4583, isFF } from "../../utils/feature-flags";
* @param {boolean} [required=false] - Whether rating validation is required
* @param {string} [requiredMessage] - Message to show if validation fails
* @param {boolean} [perRegion] - Use this tag to rate regions instead of the whole object
* @param {boolean} [perItem] - Use this tag to rate items inside the object instead of the whole object[^FF_LSDV_4583]
* @param {boolean} [perItem] - Use this tag to rate items inside the object instead of the whole object
*/
const TagAttrs = types.model({
toname: types.maybeNull(types.string),
Expand Down
4 changes: 1 addition & 3 deletions web/libs/editor/src/tags/control/Taxonomy/Taxonomy.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@ import { errorBuilder } from "../../../core/DataValidator/ConfigValidator";
*
* Use with the following data types: audio, image, HTML, paragraphs, text, time series, video.
*
* [^FF_LSDV_4583]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality
*
* @example
* <!--Labeling configuration for providing a taxonomy of choices in response to a passage of text -->
* <View>
Expand Down Expand Up @@ -88,7 +86,7 @@ import { errorBuilder } from "../../../core/DataValidator/ConfigValidator";
* @param {string} [requiredMessage] - Message to show if validation fails
* @param {string} [placeholder=] - What to display as prompt on the input
* @param {boolean} [perRegion] - Use this tag to classify specific regions instead of the whole object
* @param {boolean} [perItem] - Use this tag to classify specific items inside the object instead of the whole object[^FF_LSDV_4583]
* @param {boolean} [perItem] - Use this tag to classify specific items inside the object instead of the whole object
* @param {boolean} [legacy] - Use this tag to enable the legacy version of the Taxonomy tag. The legacy version supports the ability for annotators to add labels as needed. However, when true, the `apiUrl` parameter is not usable.
*/
const TagAttrs = types.model({
Expand Down
Loading

0 comments on commit 5de6080

Please sign in to comment.