docs: clarify that workspace name derives the Kubernetes namespace

[redhat-chai-bot]

The docs described the workspace name field as just a "Display name". In reality, the platform derives the project name (Kubernetes namespace) from it. This name is globally unique on the cluster, immutable after creation, and subject to Kubernetes naming rules.

Changes

• Updated the creation table to note that the display name derives the internal project name
• Added a new Workspace name and project name section documenting:
  • The derivation rules (generateWorkspaceName)
  • Global uniqueness constraint (409 Conflict on collision)
  • Immutability after creation
• Updated the General settings section to list the project name as read-only

Slack thread: https://redhat-internal.enterprise.slack.com/archives/C09KMNSNUDT/p1779781417071479

Summary by CodeRabbit

• Documentation
  • Updated workspace creation guidance to explain the Workspace Name field and how the Kubernetes project name is derived.
  • Added derivation rules, an example, and a warning about naming collisions and immutability.
  • Clarified that the workspace display name and description are editable, while the project name is read-only after creation.

[netlify]

✅ Deploy Preview for cheerful-kitten-f556a0 canceled.

Name	Link
🔨 Latest commit	fd3117a
🔍 Latest deploy log	https://app.netlify.com/projects/cheerful-kitten-f556a0/deploys/6a72b4d4d398b50008dd53c2

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: ead48464-b291-4981-9408-2abb6a8f4543

📥 Commits

Reviewing files that changed from the base of the PR and between 0039b91 and 14be4df.

📒 Files selected for processing (1)

• docs/src/content/docs/concepts/workspaces.md

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/src/content/docs/concepts/workspaces.md

---

📝 Walkthrough

Walkthrough

Documentation now explains how a Workspace Name produces a Kubernetes project name. It documents derivation rules, collision behavior, and immutability. Workspace settings now distinguish editable workspace fields from the read-only project name.

Changes

Workspace Naming Documentation

Layer / File(s)	Summary
Workspace creation and settings fields docs/src/content/docs/concepts/workspaces.md	The guide documents the Workspace Name field and the derived project name, including derivation rules, an example, global uniqueness, and immutability. It identifies the workspace name and description as editable, and the project name as read-only.

🚥 Pre-merge checks | ✅ 7 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title accurately describes the documentation change but omits the required scope in the type(scope): description format.	Add a scope, such as docs(workspaces): clarify that workspace name derives the Kubernetes namespace.

✅ Passed checks (7 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Performance And Algorithmic Complexity	✅ Passed	The PR changes only docs/src/content/docs/concepts/workspaces.md; it adds explanatory Markdown and no handlers, API calls, loops, lists, caches, or frontend runtime code.
Security And Secret Handling	✅ Passed	The PR changes only one Markdown documentation file. Added lines contain no plaintext secrets, tokens, API credentials, endpoints, or executable backend/Kubernetes code.
Kubernetes Resource Safety	✅ Passed	The PR changes only workspaces.md; it modifies no Kubernetes resources, workloads, RBAC definitions, or container specs, so the listed safety checks do not apply.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

✨ Simplify code

• Create PR with simplified code

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/src/content/docs/concepts/workspaces.md`:
- Around line 53-54: The docs claim "Workspace name (display name) and
description — Update at any time" but this is only true on OpenShift; on vanilla
Kubernetes these fields are not editable. Update the text for the "Workspace
name (display name) and description" entry in
docs/src/content/docs/concepts/workspaces.md to clearly state the difference
(e.g., "OpenShift: editable at any time; vanilla Kubernetes: read-only after
creation") and/or link to the "Workspace name and project name" section for
platform-specific behavior so readers know the editability depends on the
underlying platform.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 068b9d0b-5070-48c8-ab8e-1269579107a8

📥 Commits

Reviewing files that changed from the base of the PR and between d45e631 and 6dccdc8.

📒 Files selected for processing (1)

• docs/src/content/docs/concepts/workspaces.md

[coderabbitai]

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.