Skip to content

Commit

Permalink
docs: Document the min and max lengths of a feature name. (#2188)
Browse files Browse the repository at this point in the history
## What

This change adds a the min and max lengths allowed for a feature
toggle name to the feature toggle docs.

## Why

As was mentioned in #2185, this isn't documented anywhere as of today,
making it a potentially surprising issue to come across.
  • Loading branch information
thomasheartman committed Oct 13, 2022
1 parent 33c084d commit 13ea873
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion website/docs/reference/feature-toggles.mdx
Expand Up @@ -10,7 +10,7 @@ Each feature toggle has the following configuration options

| Option | Required? | Default value | Description |
| --- | --- | --- | --- |
| name | Yes | N/A | The feature toggle's name. Must be URL-friendly according to [section 2.3 of RFC 3986](https://www.rfc-editor.org/rfc/rfc3986#section-2.3) and must be unique within your Unleash instance. |
| name | Yes | N/A | The feature toggle's name. Must be URL-friendly according to [section 2.3 of RFC 3986](https://www.rfc-editor.org/rfc/rfc3986#section-2.3) and must be unique within your Unleash instance. Must be between 1 and 100 characters long, inclusive. |
| feature toggle type | Yes | Release | The [feature toggle's type](../advanced/feature-toggle-types.md). |
| project | Yes | The [default project](../user_guide/projects.md#the-default-project). When created from a project page in the admin UI, that project will be the default value instead. | The [project](../user_guide/projects.md) that should contain the feature toggle. |
| description | No | N/A | A description of the feature toggle's purpose. |
Expand Down

0 comments on commit 13ea873

Please sign in to comment.