docs: clarify that workspace name derives the Kubernetes namespace#1606
Open
redhat-chai-bot wants to merge 1 commit into
Open
docs: clarify that workspace name derives the Kubernetes namespace#1606redhat-chai-bot wants to merge 1 commit into
redhat-chai-bot wants to merge 1 commit into
Conversation
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 is globally unique, immutable after creation, and subject to K8s naming rules. Add a new section documenting the derivation rules, uniqueness constraint, and immutability. Update the creation table and General settings section accordingly.
✅ Deploy Preview for cheerful-kitten-f556a0 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughDocumentation updated to clarify workspace naming conventions. The "Creating a workspace" section now explains that "Workspace Name" input yields a derived Kubernetes "project name," including derivation rules, collision behavior, and immutability. The "Workspace settings" section distinguishes editable fields from the read-only "project name." ChangesWorkspace Field Documentation
🚥 Pre-merge checks | ✅ 8✅ Passed checks (8 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
docs/src/content/docs/concepts/workspaces.md
Comment on lines
+53
to
+54
| - **Workspace name (display name) and description** -- Update at any time. | ||
| - **Project name** -- The Kubernetes namespace for this workspace. Read-only after creation (see [Workspace name and project name](#workspace-name-and-project-name)). |
Contributor
There was a problem hiding this comment.
General settings editability is overstated for vanilla Kubernetes.
Line 53 says “Workspace name (display name) and description — Update at any time,” but current behavior is OpenShift-only; on vanilla Kubernetes these fields are not editable. This creates a user-facing docs mismatch.
Proposed doc fix
-- **Workspace name (display name) and description** -- Update at any time.
+- **Workspace display name and description** -- Editable on OpenShift clusters.
+ On vanilla Kubernetes, these metadata fields are not editable in the UI.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - **Workspace name (display name) and description** -- Update at any time. | |
| - **Project name** -- The Kubernetes namespace for this workspace. Read-only after creation (see [Workspace name and project name](#workspace-name-and-project-name)). | |
| - **Workspace display name and description** -- Editable on OpenShift clusters. | |
| On vanilla Kubernetes, these metadata fields are not editable in the UI. | |
| - **Project name** -- The Kubernetes namespace for this workspace. Read-only after creation (see [Workspace name and project name](`#workspace-name-and-project-name`)). |
🤖 Prompt for 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.
In `@docs/src/content/docs/concepts/workspaces.md` around lines 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
generateWorkspaceName)Slack thread: https://redhat-internal.enterprise.slack.com/archives/C09KMNSNUDT/p1779781417071479
Summary by CodeRabbit