Skip to content

NO-JIRA: docs: add repositories page listing team-owned repos#8505

Merged
openshift-merge-bot[bot] merged 1 commit into
openshift:mainfrom
bryan-cox:document-hypershift-repos
May 13, 2026
Merged

NO-JIRA: docs: add repositories page listing team-owned repos#8505
openshift-merge-bot[bot] merged 1 commit into
openshift:mainfrom
bryan-cox:document-hypershift-repos

Conversation

@bryan-cox
Copy link
Copy Markdown
Member

@bryan-cox bryan-cox commented May 13, 2026

Summary

  • Adds a new "Repositories" page under the Contribute section documenting all 6 repos the HyperShift team owns
  • Groups repos by category: Core, Disaster Recovery, Encryption and KMS, Networking
  • Includes upstream fork links where applicable
  • Updates mkdocs nav and contribute index page

Test plan

  • Verify page renders correctly via mkdocs serve
  • Confirm all GitHub links resolve

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added a new "Repositories" page to the contribution guide listing HyperShift-related projects (Core, Disaster Recovery, Encryption/KMS, Networking, and related plugins).
    • Added a link to the new "Repositories" page in the Contribute index and site navigation for easier discovery.

@openshift-merge-bot
Copy link
Copy Markdown
Contributor

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label May 13, 2026
@openshift-ci-robot
Copy link
Copy Markdown

@bryan-cox: This pull request explicitly references no jira issue.

Details

In response to this:

Summary

  • Adds a new "Repositories" page under the Contribute section documenting all 6 repos the HyperShift team owns
  • Groups repos by category: Core, Disaster Recovery, Encryption and KMS, Networking
  • Includes upstream fork links where applicable
  • Updates mkdocs nav and contribute index page

Test plan

  • Verify page renders correctly via mkdocs serve
  • Confirm all GitHub links resolve

🤖 Generated with Claude Code

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.

@openshift-ci openshift-ci Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 13, 2026
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 13, 2026

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@openshift-ci openshift-ci Bot added do-not-merge/needs-area area/documentation Indicates the PR includes changes for documentation and removed do-not-merge/needs-area labels May 13, 2026
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 13, 2026

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 13, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 13, 2026

📝 Walkthrough

Walkthrough

Adds 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

  • New file: docs/content/contribute/repositories.md — repository table and introductory text.
  • Modified: docs/content/contribute/index.md — added “Repositories” list item linking to the new page.
  • Modified: docs/mkdocs.yml — added navigation entry under Contribute for the new page.

Estimated code review effort

Low — trivial documentation addition (1–2 minutes).

🚥 Pre-merge checks | ✅ 12
✅ Passed checks (12 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding a repositories page that lists team-owned repositories for documentation purposes.
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.
Stable And Deterministic Test Names ✅ Passed PR contains only documentation changes (Markdown and YAML files). No Ginkgo tests are present, so the test naming stability check does not apply.
Test Structure And Quality ✅ Passed This PR only adds/modifies documentation files (Markdown and mkdocs configuration). The custom check for Ginkgo test code quality is not applicable as there are no test files in this PR.
Microshift Test Compatibility ✅ Passed Check not applicable. PR contains only documentation and config changes (repositories.md, mkdocs.yml, index updates). No Ginkgo e2e tests are added.
Single Node Openshift (Sno) Test Compatibility ✅ Passed PR contains only documentation changes (Markdown and YAML config). No Ginkgo e2e tests or Go test code added. Custom check for SNO test compatibility is not applicable.
Topology-Aware Scheduling Compatibility ✅ Passed PR contains only documentation changes (Markdown and mkdocs config). No deployment manifests, operator code, or controllers are modified. Check is not applicable.
Ote Binary Stdout Contract ✅ Passed PR contains only documentation changes (Markdown and YAML files). OTE Binary Stdout Contract check applies to executable code that emits stdout. No source code or binaries were modified.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed PR contains only documentation and configuration changes. No Ginkgo e2e tests are being added, so the IPv6/disconnected network compatibility check does not apply.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot temporarily deployed to docs-preview/pr-8505 May 13, 2026 17:59 Inactive
@bryan-cox bryan-cox force-pushed the document-hypershift-repos branch from 6196856 to b96fad0 Compare May 13, 2026 18:09
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@bryan-cox bryan-cox force-pushed the document-hypershift-repos branch from b96fad0 to 5cb2ac9 Compare May 13, 2026 18:09
@bryan-cox bryan-cox marked this pull request as ready for review May 13, 2026 18:12
@openshift-ci openshift-ci Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 13, 2026
@openshift-ci openshift-ci Bot requested review from csrwng and sjenning May 13, 2026 18:12
@bryan-cox
Copy link
Copy Markdown
Member Author

/verified by @bryan-cox

I reviewed the GHA deployments

@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label May 13, 2026
@openshift-ci-robot
Copy link
Copy Markdown

@bryan-cox: This PR has been marked as verified by @bryan-cox.

Details

In response to this:

/verified by @bryan-cox

I reviewed the GHA deployments

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/content/contribute/repositories.md (1)

9-16: ⚡ Quick win

Inconsistency: 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

📥 Commits

Reviewing files that changed from the base of the PR and between 6196856 and 5cb2ac9.

⛔ Files ignored due to path filters (1)
  • docs/content/reference/aggregated-docs.md is excluded by !docs/content/reference/aggregated-docs.md
📒 Files selected for processing (3)
  • docs/content/contribute/index.md
  • docs/content/contribute/repositories.md
  • docs/mkdocs.yml
✅ Files skipped from review due to trivial changes (2)
  • docs/content/contribute/index.md
  • docs/mkdocs.yml

@csrwng
Copy link
Copy Markdown
Contributor

csrwng commented May 13, 2026

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label May 13, 2026
@openshift-merge-bot
Copy link
Copy Markdown
Contributor

Pipeline controller notification

No second-stage tests were triggered for this PR.

This can happen when:

  • The changed files don't match any pipeline_run_if_changed patterns
  • All files match pipeline_skip_if_only_changed patterns
  • No pipeline-controlled jobs are defined for the main branch

Use /test ? to see all available tests.

@openshift-merge-bot openshift-merge-bot Bot merged commit 74753b3 into openshift:main May 13, 2026
19 of 20 checks passed
@bryan-cox bryan-cox deleted the document-hypershift-repos branch May 13, 2026 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/documentation Indicates the PR includes changes for documentation jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. verified Signifies that the PR passed pre-merge verification criteria

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants