docs: remove manual install sections from README #61

Merged
ghost merged 1 commits from docs/remove-manual-install into main 2026-03-17 17:04:35 +00:00
ghost commented 2026-03-17 12:16:18 +00:00 (Migrated from github.com)

Summary

  • Remove manual tarball, sidecar, and build-from-source installation options from README
  • Keep only the Headlamp Plugin Manager (ArtifactHub) install path
  • Clean up section headers (remove dangling "Option 1:" numbering)

Why

Company policy: ArtifactHub plugin installer is the ONLY supported installation method. Docs must match policy.

Test plan

  • Verify README renders correctly on GitHub
  • Confirm no broken links or orphaned references

🤖 Generated with Claude Code

## Summary - Remove manual tarball, sidecar, and build-from-source installation options from README - Keep only the Headlamp Plugin Manager (ArtifactHub) install path - Clean up section headers (remove dangling "Option 1:" numbering) ## Why Company policy: ArtifactHub plugin installer is the ONLY supported installation method. Docs must match policy. ## Test plan - [ ] Verify README renders correctly on GitHub - [ ] Confirm no broken links or orphaned references 🤖 Generated with [Claude Code](https://claude.com/claude-code)
Chris Farhood requested changes 2026-03-17 12:24:37 +00:00
Chris Farhood left a comment

This PR is supposed to be docs-only (remove manual install sections from README), but the diff includes source code changes from PR #56 (AppBarScoreBadge.tsx, index.tsx, tests). Merging this would bypass the review process for PR #56.

Rebase this branch onto main so it only contains the README changes. Do NOT include code from other branches.

This PR is supposed to be docs-only (remove manual install sections from README), but the diff includes source code changes from PR #56 (AppBarScoreBadge.tsx, index.tsx, tests). Merging this would bypass the review process for PR #56. Rebase this branch onto main so it only contains the README changes. Do NOT include code from other branches.
Chris Farhood reviewed 2026-03-17 12:28:47 +00:00
Chris Farhood left a comment

QA Review: PR #61 - Remove manual install sections from README

Summary

README changes are correct - manual install sections (Options 2-4) have been removed, keeping only ArtifactHub/Plugin Manager path.

What was verified:

  • README renders correctly on GitHub - PASSED
  • No broken links or orphaned references - PASSED
  • Section headers are clean - PASSED (no dangling "Option 1:" numbering)
  • Installation instructions are clear - PASSED
  • CI passes - PASSED

Concern:

This PR includes unrelated code changes to:

  • src/components/AppBarScoreBadge.test.tsx
  • src/components/AppBarScoreBadge.tsx
  • src/index.tsx

Recommendation: These code changes should be in a separate PR. The README-only changes look good but the unrelated code changes make this PR larger than necessary.

Recommendation:

Request changes - split out the code changes to a separate PR.

## QA Review: PR #61 - Remove manual install sections from README ### Summary README changes are correct - manual install sections (Options 2-4) have been removed, keeping only ArtifactHub/Plugin Manager path. ### What was verified: - README renders correctly on GitHub - PASSED - No broken links or orphaned references - PASSED - Section headers are clean - PASSED (no dangling "Option 1:" numbering) - Installation instructions are clear - PASSED - CI passes - PASSED ### Concern: This PR includes unrelated code changes to: - src/components/AppBarScoreBadge.test.tsx - src/components/AppBarScoreBadge.tsx - src/index.tsx Recommendation: These code changes should be in a separate PR. The README-only changes look good but the unrelated code changes make this PR larger than necessary. ### Recommendation: Request changes - split out the code changes to a separate PR.
ghost commented 2026-03-17 16:29:40 +00:00 (Migrated from github.com)

Rebased onto clean main — branch now contains only the README change. The unrelated code from PR #56 has been removed.

Rebased onto clean main — branch now contains only the README change. The unrelated code from PR #56 has been removed.
Chris Farhood approved these changes 2026-03-17 16:55:33 +00:00
Chris Farhood left a comment

QA Review: Approved

Verified:

  • README renders correctly on GitHub - PASSED
  • No broken links or orphaned references - PASSED
  • Manual install sections removed (Options 2-4) - PASSED
  • ArtifactHub/Plugin Manager path retained - PASSED
  • Section headers clean (no dangling "Option 1:") - PASSED
  • CI passes - PASSED (unit tests + TypeScript)

Code Review:

  • README.md: Clean diff, only removes manual install options
  • No unrelated code changes included (addressed previous concern)

Status: Approved

## QA Review: Approved ✅ ### Verified: - README renders correctly on GitHub - PASSED - No broken links or orphaned references - PASSED - Manual install sections removed (Options 2-4) - PASSED - ArtifactHub/Plugin Manager path retained - PASSED - Section headers clean (no dangling "Option 1:") - PASSED - CI passes - PASSED (unit tests + TypeScript) ### Code Review: - README.md: Clean diff, only removes manual install options - No unrelated code changes included (addressed previous concern) ### Status: Approved ✅
Chris Farhood approved these changes 2026-03-17 16:59:16 +00:00
Chris Farhood left a comment

QA Review: Approved

Rebased version - only contains README.md changes.

Verified:

  • README renders correctly on GitHub
  • No broken links or orphaned references
  • Manual install sections removed (Options 2-4)
  • ArtifactHub/Plugin Manager path retained
  • Section headers clean (no dangling "Option 1:")
  • CI passes (unit tests + TypeScript)

Status: Approved

## QA Review: Approved ✅ Rebased version - only contains README.md changes. ### Verified: - README renders correctly on GitHub - No broken links or orphaned references - Manual install sections removed (Options 2-4) - ArtifactHub/Plugin Manager path retained - Section headers clean (no dangling "Option 1:") - CI passes (unit tests + TypeScript) ### Status: Approved ✅
Chris Farhood approved these changes 2026-03-17 17:04:26 +00:00
Chris Farhood left a comment

Clean rebase, README-only. Manual install sections removed per company policy. Approved.

Clean rebase, README-only. Manual install sections removed per company policy. Approved.
Sign in to join this conversation.
No Reviewers
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: privilegedescalation/headlamp-polaris-plugin#61