privilegedescalation/headlamp-polaris-plugin
12
0
Fork 0
Code Issues 4 Pull Requests 3 Actions Packages Projects Releases 50 Wiki Activity

docs: replace hardcoded namespace with <your-namespace> placeholder #155

Merged
privilegedescalation-ceo[bot] merged 4 commits from docs/namespace-placeholder-PRI-433 into main 2026-05-10 21:34:50 +00:00
Conversation 3 Commits 4 Files Changed 17
+138 -140
privilegedescalation-ceo[bot] commented 2026-05-10 21:21:50 +00:00 (Migrated from github.com)
Copy Link
Copy Source

Summary

Replace all hardcoded Headlamp install namespace references in user-facing documentation with <your-namespace> placeholders so users substitute their own value.

  • 14 files updated across README, SECURITY, deployment guides, getting-started, troubleshooting, and user-guide docs
  • Consistent placeholder conventions: --namespace <your-namespace>, -n <your-namespace>, namespace: <your-namespace>
  • Prose references changed to "the namespace where Headlamp is installed"

In-scope files updated

  • README.md, SECURITY.md
  • docs/deployment/helm.md, kubernetes.md, production.md
  • docs/getting-started/installation.md, quick-start.md, prerequisites.md
  • docs/troubleshooting/README.md, common-issues.md, rbac-issues.md
  • docs/user-guide/rbac-permissions.md
  • docs/TESTING.md, docs/development/testing.md

Out-of-scope references confirmed untouched

  • kube-system in NetworkPolicy selectors (targets API server, not Headlamp)
  • polaris namespace references (upstream workload location)
  • Source code and test files (kube-system there refers to watched upstream workload)
  • CONTEXT.md, CONTRIBUTING.md, e2e/README.md, deployment/ YAML manifests (internal/CI files)

Test plan

  • Verify no headlamp or kube-system namespace hardcoding remains in user-facing docs (except legitimate upstream/API-server references)
  • Confirm source code files are untouched
  • Review placeholder consistency across all updated files

Refs: PRI-433

🤖 Generated with Claude Code

## Summary Replace all hardcoded Headlamp install namespace references in user-facing documentation with `<your-namespace>` placeholders so users substitute their own value. - **14 files updated** across README, SECURITY, deployment guides, getting-started, troubleshooting, and user-guide docs - Consistent placeholder conventions: `--namespace <your-namespace>`, `-n <your-namespace>`, `namespace: <your-namespace>` - Prose references changed to "the namespace where Headlamp is installed" ## In-scope files updated - `README.md`, `SECURITY.md` - `docs/deployment/helm.md`, `kubernetes.md`, `production.md` - `docs/getting-started/installation.md`, `quick-start.md`, `prerequisites.md` - `docs/troubleshooting/README.md`, `common-issues.md`, `rbac-issues.md` - `docs/user-guide/rbac-permissions.md` - `docs/TESTING.md`, `docs/development/testing.md` ## Out-of-scope references confirmed untouched - `kube-system` in NetworkPolicy selectors (targets API server, not Headlamp) - `polaris` namespace references (upstream workload location) - Source code and test files (`kube-system` there refers to watched upstream workload) - `CONTEXT.md`, `CONTRIBUTING.md`, `e2e/README.md`, `deployment/` YAML manifests (internal/CI files) ## Test plan - [ ] Verify no `headlamp` or `kube-system` namespace hardcoding remains in user-facing docs (except legitimate upstream/API-server references) - [ ] Confirm source code files are untouched - [ ] Review placeholder consistency across all updated files Refs: PRI-433 🤖 Generated with [Claude Code](https://claude.com/claude-code)
greptile-apps[bot] (Migrated from github.com) reviewed 2026-05-10 21:21:56 +00:00
greptile-apps[bot] (Migrated from github.com) left a comment
Copy Link
Copy Source

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method [here](https://app.greptile.com/review/github).
greptile-apps[bot] (Migrated from github.com) reviewed 2026-05-10 21:33:53 +00:00
greptile-apps[bot] (Migrated from github.com) left a comment
Copy Link
Copy Source

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method [here](https://app.greptile.com/review/github).
greptile-apps[bot] (Migrated from github.com) reviewed 2026-05-10 21:34:50 +00:00
greptile-apps[bot] (Migrated from github.com) left a comment
Copy Link
Copy Source

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method [here](https://app.greptile.com/review/github).
Sign in to join this conversation.
Reviewers
No Reviewers
greptile-apps[bot]
Labels
Clear labels
P0
Must fix - blocking
 P0
Must fix - blocking
 bug
Something isn't working
 bug
Something isn't working
 cla:approved
cla:approved
confirmed
confirmed
documentation
Improvements or additions to documentation
 documentation
Improvements or additions to documentation
 duplicate
This issue or pull request already exists
 duplicate
This issue or pull request already exists
 e2e
e2e
enhancement
New feature or request
 enhancement
New feature or request
 good first issue
Good for newcomers
 good first issue
Good for newcomers
 help wanted
Extra attention is needed
 help wanted
Extra attention is needed
 infra
Infrastructure/ops work
 infra
Infrastructure/ops work
 invalid
This doesn't seem right
 invalid
This doesn't seem right
 pri-917
pri-917
question
Further information is requested
 question
Further information is requested
 typecheck
typecheck
typescript
typescript
wontfix
This will not be worked on
 wontfix
This will not be worked on
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
cpfarhood (Chris Farhood) ci (Continuous Integration [bot]) pe_countess (Countess von Containerheim) flux (Flux CD) pe_gandalf (Gandalf the Greybeard) admin (Gitea Admin) pe_hugh (Hugh Hackman) pe_karen (Kubectl Karen) renovate (Mend Renovate) pe_nancy (Null Pointer Nancy) pe_patty (Pixel Patty) pe_regina (Regression Regina)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: privilegedescalation/headlamp-polaris-plugin#155
Delete Branch "docs/namespace-placeholder-PRI-433"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?