NO-JIRA: docs: add repositories page listing team-owned repos#8505
Conversation
|
Pipeline controller notification For optional jobs, comment This repository is configured in: LGTM mode |
|
@bryan-cox: This pull request explicitly references no jira issue. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
Skipping CI for Draft Pull Request. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: bryan-cox The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
📝 WalkthroughWalkthroughAdds a new Contribute documentation page, docs/content/contribute/repositories.md, which lists HyperShift-related GitHub repositories grouped by category (Core, Disaster Recovery, Encryption and KMS, Networking) with links and descriptions. The Contribute index (docs/content/contribute/index.md) gains a “Repositories” link, and docs/mkdocs.yml navigation is updated to include the new page. Changes
Estimated code review effortLow — trivial documentation addition (1–2 minutes). 🚥 Pre-merge checks | ✅ 12✅ Passed checks (12 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
6196856 to
b96fad0
Compare
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
b96fad0 to
5cb2ac9
Compare
|
/verified by @bryan-cox I reviewed the GHA deployments |
|
@bryan-cox: This PR has been marked as verified by DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/content/contribute/repositories.md (1)
9-16: ⚡ Quick winInconsistency: Categories mentioned in PR description are not present in the implementation.
The PR description states "Groups repositories by category: Core, Disaster Recovery, Encryption and KMS, Networking" but the actual content shows a flat list without category groupings. Consider organizing the table with category headers to improve readability and match the stated implementation.
📋 Suggested structure with categories
# Repositories The HyperShift team owns and maintains the following repositories. +## Core + | Repository | Description | Upstream | |---|---|---| | [openshift/hypershift](https://github.com/openshift/hypershift) | Main repository containing the HyperShift Operator, Control Plane Operator, CLI, API definitions, and tests. | | | [hypershift-community/hypershift](https://github.com/hypershift-community/hypershift) | Community fork synced from openshift/hypershift. | | + +## Disaster Recovery + +| Repository | Description | Upstream | +|---|---|---| | [openshift/hypershift-oadp-plugin](https://github.com/openshift/hypershift-oadp-plugin) | OADP (OpenShift API for Data Protection) plugin for HostedControlPlane backup and restore. | | + +## Encryption and KMS + +| Repository | Description | Upstream | +|---|---|---| | [openshift/aws-encryption-provider](https://github.com/openshift/aws-encryption-provider) | API server encryption provider backed by AWS KMS. | [kubernetes-sigs/aws-encryption-provider](https://github.com/kubernetes-sigs/aws-encryption-provider) | | [openshift/azure-kubernetes-kms](https://github.com/openshift/azure-kubernetes-kms) | Azure Key Vault KMS plugin for the Kubernetes API server. | [Azure/kubernetes-kms](https://github.com/Azure/kubernetes-kms) | + +## Networking + +| Repository | Description | Upstream | +|---|---|---| | [openshift/apiserver-network-proxy](https://github.com/openshift/apiserver-network-proxy) | Konnectivity proxy enabling secure communication between the API server and cluster nodes. | [kubernetes-sigs/apiserver-network-proxy](https://github.com/kubernetes-sigs/apiserver-network-proxy) |🤖 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/content/contribute/repositories.md` around lines 9 - 16, The table currently lists repositories flat (e.g., rows starting with "[openshift/hypershift]", "[hypershift-community/hypershift]", etc.) but the PR promised grouping by category; update docs/content/contribute/repositories.md to group entries under category headings ("Core", "Disaster Recovery", "Encryption and KMS", "Networking") by splitting the single table into sections or adding category header rows above the relevant repository rows (for example put openshift/hypershift and hypershift-community/hypershift under "Core", openshift/hypershift-oadp-plugin under "Disaster Recovery", aws-encryption-provider and azure-kubernetes-kms under "Encryption and KMS", and apiserver-network-proxy under "Networking"), ensuring each section keeps the same three-column table structure (Repository | Description | Upstream) and consistent markdown formatting.
🤖 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.
Nitpick comments:
In `@docs/content/contribute/repositories.md`:
- Around line 9-16: The table currently lists repositories flat (e.g., rows
starting with "[openshift/hypershift]", "[hypershift-community/hypershift]",
etc.) but the PR promised grouping by category; update
docs/content/contribute/repositories.md to group entries under category headings
("Core", "Disaster Recovery", "Encryption and KMS", "Networking") by splitting
the single table into sections or adding category header rows above the relevant
repository rows (for example put openshift/hypershift and
hypershift-community/hypershift under "Core", openshift/hypershift-oadp-plugin
under "Disaster Recovery", aws-encryption-provider and azure-kubernetes-kms
under "Encryption and KMS", and apiserver-network-proxy under "Networking"),
ensuring each section keeps the same three-column table structure (Repository |
Description | Upstream) and consistent markdown formatting.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: 65b67bc5-d500-406c-af98-c51665aec84f
⛔ Files ignored due to path filters (1)
docs/content/reference/aggregated-docs.mdis excluded by!docs/content/reference/aggregated-docs.md
📒 Files selected for processing (3)
docs/content/contribute/index.mddocs/content/contribute/repositories.mddocs/mkdocs.yml
✅ Files skipped from review due to trivial changes (2)
- docs/content/contribute/index.md
- docs/mkdocs.yml
|
/lgtm |
|
Pipeline controller notification No second-stage tests were triggered for this PR. This can happen when:
Use |
74753b3
into
openshift:main
Summary
Test plan
mkdocs serve🤖 Generated with Claude Code
Summary by CodeRabbit