Skip to content
This repository was archived by the owner on Dec 29, 2025. It is now read-only.

Commit 4128470

Browse files
committed
add documentation about workspace and project identifier restrictions
1 parent f611e34 commit 4128470

File tree

4 files changed

+31
-3
lines changed

4 files changed

+31
-3
lines changed

docs/concepts/project.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,22 @@ Below is a visual example of how projects are structured in meshStack:
1717

1818
![Project concept diagram](/assets/new_concept/concept_project.png)
1919

20+
## Project Names and Identifiers
21+
22+
Each project has both a display name and a unique identifier.
23+
24+
**Project Name (Display Name)**
25+
- Maximum length of 30 characters
26+
- Can contain any characters
27+
28+
**Project Identifier**
29+
- Must contain only lowercase alphanumeric characters and hyphens (but not leading, trailing, or consecutive hyphens)
30+
- Maximum length of 30 characters
31+
- Cannot be changed after project creation
32+
33+
These default restrictions can be configured differently upon request to accommodate your organization's needs.
34+
The restrictions exist to ensure the combined `${workspaceIdentifier}.${projectIdentifier}` fits within cloud platform constraints (e.g., AWS account aliases: 64 chars, Kubernetes namespaces: 63 chars).
35+
2036
## Related Resources
2137

2238
### Concepts

docs/concepts/workspace.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,18 @@ Below is a visual example of how workspaces are structured in meshStack:
2222

2323
![Workspace concept diagram](/assets/new_concept/concept_workspace.png)
2424

25+
## Workspace Identifiers
26+
27+
Each workspace has a unique identifier that is used to reference the workspace in APIs, integrations, and platform resources.
28+
29+
**Default Restrictions:**
30+
- Must be alphanumeric with hyphens allowed (but not leading, trailing, or consecutive hyphens)
31+
- Maximum length of 16 characters
32+
- Cannot be changed after workspace creation
33+
34+
These default restrictions can be configured differently upon request to accommodate your organization's needs.
35+
The restrictions exist to ensure the combined `${workspaceIdentifier}.${projectIdentifier}` fits within cloud platform constraints (e.g., AWS account aliases: 64 chars, Kubernetes namespaces: 63 chars).
36+
2537
## Related Resources
2638

2739
### Concepts

docs/guides/core/how-to-manage-a-project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This guide explains how to manage projects in meshStack, including user access,
2121
**Step by Step Guide:**
2222

2323
1. Start the wizard by selecting "Create Project" in the project tab inside the workspace manager.
24-
2. Fill in the required details such as name, ID, and tag information.
24+
2. Fill in the required details such as name, [identifier](../../concepts/project.md#project-names-and-identifiers), and tag information.
2525
3. Review the project details and confirm creation.
2626

2727
### Creating a Project as an Administrator

docs/guides/core/how-to-manage-a-workspace.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Here are short guides on how to handle the most common tasks in a workspace.
1919
**Step by Step Guide:**
2020

2121
1. Start the wizard by selecting "Create Workspace" in the workspace drop-down in the top navigation bar.
22-
2. Fill in the required details such as name, ID, and tag information.
22+
2. Fill in the required details such as name, [identifier](../../concepts/workspace.md#workspace-identifiers) and tag information.
2323
3. Onboard the initial team members.
2424
4. Review the workspace details and confirm creation.
2525

@@ -33,7 +33,7 @@ Here are short guides on how to handle the most common tasks in a workspace.
3333

3434
1. Navigate to the admin area and select "Workspaces."
3535
2. Click on "Create Workspace."
36-
3. Fill in the required details such as name, ID, and tag information.
36+
3. Fill in the required details such as name, [identifier](../../concepts/workspace.md#workspace-identifiers) and tag information.
3737
4. Assign initial users and roles.
3838
5. Review the workspace details and confirm creation.
3939

0 commit comments

Comments
 (0)