Skip to content

Commit 1f3fd56

Browse files
feat: Add naming requirements to the environment doc (#14505)
Currently, some platforms include this information in their docs while others don't, making it difficult to provide a platform specific link in our app. Given that we already have a dedicated document covering environments and that this document can be used by any platform, we can just add a section describing the naming requirements.
1 parent 859be5c commit 1f3fd56

File tree

1 file changed

+11
-1
lines changed
  • docs/concepts/key-terms/environments

1 file changed

+11
-1
lines changed

docs/concepts/key-terms/environments/index.mdx

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,17 @@ Environments are unique to each organization. Environment settings, however, are
1616

1717
## Creating Environments
1818

19-
Sentry automatically creates environments when it receives an [event](/api/events/) with the environment tag. Environments are case-sensitive. You can also create an environment when you first `init` your SDK, [as documented for each SDK](/platform-redirect/?next=/configuration/environments/).
19+
Sentry automatically creates environments when it receives an [event](/api/events/) with the environment tag. You can also create an environment when you first `init` your SDK, [as documented for each SDK](/platform-redirect/?next=/configuration/environments/).
20+
21+
### Environment Naming Requirements
22+
23+
When creating environments, be aware of the following requirements:
24+
25+
- Environment names are **case-sensitive**
26+
- Names cannot contain **newlines, spaces, or forward slashes**
27+
- Names cannot be the string **"None"**
28+
- Names cannot exceed **64 characters**
29+
- You **cannot delete** environments, but you can [hide them](#hidden-environments)
2030

2131
## Filtering Environments
2232

0 commit comments

Comments
 (0)