Skip to content
This repository was archived by the owner on Dec 29, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/concepts/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,22 @@ Below is a visual example of how projects are structured in meshStack:

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

## Project Names and Identifiers

Each project has both a display name and a unique identifier.

**Project Name (Display Name)**
- Maximum length of 30 characters
- Can contain any characters

**Project Identifier**
- Must contain only lowercase alphanumeric characters and hyphens (but not leading, trailing, or consecutive hyphens)
- Maximum length of 30 characters
- Cannot be changed after project creation

These default restrictions can be configured differently upon request to accommodate your organization's needs.
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).

## Related Resources

### Concepts
Expand Down
12 changes: 12 additions & 0 deletions docs/concepts/workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,18 @@ Below is a visual example of how workspaces are structured in meshStack:

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

## Workspace Identifiers

Each workspace has a unique identifier that is used to reference the workspace in APIs, integrations, and platform resources.

**Default Restrictions:**
- Must be alphanumeric with hyphens allowed (but not leading, trailing, or consecutive hyphens)
- Maximum length of 16 characters
- Cannot be changed after workspace creation

These default restrictions can be configured differently upon request to accommodate your organization's needs.
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).

## Related Resources

### Concepts
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/core/how-to-manage-a-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This guide explains how to manage projects in meshStack, including user access,
**Step by Step Guide:**

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

### Creating a Project as an Administrator
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/core/how-to-manage-a-workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Here are short guides on how to handle the most common tasks in a workspace.
**Step by Step Guide:**

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

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

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

Expand Down