Skip to content

docs: comprehensive architecture repo cleanup (WS1+WS2+WS3-A)#111

Open
rh-amarin wants to merge 20 commits intomainfrom
cleanup/ws1-ws2-ws3-structural-hygiene
Open

docs: comprehensive architecture repo cleanup (WS1+WS2+WS3-A)#111
rh-amarin wants to merge 20 commits intomainfrom
cleanup/ws1-ws2-ws3-structural-hygiene

Conversation

@rh-amarin
Copy link
Collaborator

@rh-amarin rh-amarin commented Mar 25, 2026

Summary

This PR implements the bulk of the HyperFleet architecture repository cleanup described in the JIRA ticket, covering WS1 (Structural Hygiene), WS2 (Document Standardization), and WS3-A (broker component design doc).

WS1 — Structural Hygiene and Accuracy

  • README.md structure diagram: Completely rewritten to match actual repo layout (was listing ~10 non-existent files and omitting 5+ major directories)
  • architecture-summary.md broken links: Removed references to non-existent component-architecture-diagram.md and data-flow-diagram.md; the inline diagrams already present cover this content
  • components/CLAUDE.md: Added metadata header; added claude-code-plugin/ to component directory table
  • standards/CLAUDE.md: Added metadata header; added helm-chart-conventions.md to standards table
  • README.md Contact section: Replaced //todo placeholders with Slack channel and contact info
  • CONTRIBUTING.md: Created from docs/templates/CONTRIBUTING.md.template, adapted for this documentation-only repo (no build steps, focus on document standards, PR/commit process)

WS2 — Document Standardization

  • Metadata headers: Added Status / Owner / Last Updated headers to 61 documents across all directories
  • Human-readable summaries: Added 2–4 sentence summaries to every document so readers can understand purpose without reading the full file
  • MVP docs marked Historical: mvp-scope.md and mvp-working-agreement.md now show Status: Historical with explanatory summary
  • Deprecation READMEs: Added README.md to all 5 deprecated adapter directories explaining what was deprecated, when, why, and what replaced it:
    • DNS-deprecated/GCP/
    • PullSecret-deprecated/GCP/
    • hypershift-deprecated/GCP/
    • maestro-cli-deprecated/
    • validation-deprecated/GCP/

WS3-A — Broker Component Design Document

  • hyperfleet/components/broker/broker.md: Full component design document including:
    • What & Why
    • Topic/subscription model with Mermaid diagram
    • CloudEvent format
    • Supported broker implementations (GCP Pub/Sub, RabbitMQ, Stub)
    • Configuration examples for Sentinel and Adapters
    • Event flow sequence diagram
    • Design decisions (anemic events, fan-out via subscriptions, pluggable abstraction)
    • Trade-offs (gains, losses, technical debt)
    • Alternatives Considered (direct RPC, outbox pattern, competing consumers)
    • Dependencies and Go interfaces

What's NOT in This PR

  • api-service/api-service.md (TASK-013) — requires API team input for accuracy
  • glossary.md (TASK-014) — separate PR
  • ADR index (TASK-015) — separate PR
  • Trade-offs section for sentinel.md (TASK-010) — requires sentinel team review
  • post-mvp-actions.md disposition (TASK-016) — needs owner decision

Test Plan

  • Verify markdownlint passes in CI
  • Verify link checker passes (broken links in architecture-summary.md removed)
  • Spot-check metadata headers across directories
  • Confirm broker.md renders correctly on GitHub (Mermaid diagrams)
  • Confirm deprecated README files are visible in GitHub UI

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added CONTRIBUTING with contribution categories, document templates, lint/link checks, commit/PR workflow and message guidance.
    • Reworked README and reorganized repository layout, adding per-component dirs, deployment, standards, testing, and release guides.
    • Standardized front-matter across many docs (Status, Owner, Last Updated) and updated historical/deprecation notices.
    • Added a Message Broker component page and expanded API, Sentinel, Adapter, and standards guidance.

@openshift-ci openshift-ci bot requested review from tzhou5 and yingzhanredhat March 25, 2026 07:18
@openshift-ci
Copy link

openshift-ci bot commented Mar 25, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign aredenba-rh for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 25, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

Adds CONTRIBUTING.md and reorganizes the README into a deeper hyperfleet/ subtree with new top-level documents and directories. Prepends Status/Owner/Last Updated metadata and short scope blockquotes to 50+ Markdown files across architecture, components, standards, deployment, testing, mvp, and deprecated locations. Introduces a new broker component document describing a fan-out publish/subscribe broker (GCP Pub/Sub, RabbitMQ, in-memory), a CloudEvents-based minimal event contract, and adapter consumption pattern. Adds several new component subdirectories, per-component guidance files, and deprecation notices for archived spikes.

Sequence Diagram(s)

sequenceDiagram
    participant Sentinel as Sentinel
    participant Broker as Message Broker
    participant Adapter as Adapter
    participant API as HyperFleet API

    rect rgba(100,150,240,0.5)
        Sentinel->>Broker: Publish CloudEvent (resource id + minimal data)
    end

    rect rgba(120,200,140,0.5)
        Broker-->>Adapter: Fan-out delivery to each adapter subscription
    end

    rect rgba(240,180,80,0.5)
        Adapter->>API: Fetch full resource details
        Adapter->>API: Upsert status (Available/Applied/Health, observed_generation)
    end

    Note over Broker,Adapter: Broker backends: GCP Pub/Sub / RabbitMQ / in-memory
    Note over Adapter,API: At-least-once delivery — adapters handle duplicates/out-of-order
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title clearly summarizes the main comprehensive cleanup effort across three workstreams (WS1, WS2, WS3-A), matching the changeset's primary focus on documentation standardization, structural hygiene, and broker component design.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cleanup/ws1-ws2-ws3-structural-hygiene

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

Copy link
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.

Actionable comments posted: 5

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
hyperfleet/docs/prow-cicd-cluster.md (1)

254-254: ⚠️ Potential issue | 🟡 Minor

Consider removing duplicate "Last Updated" field.

The document now has two "Last Updated" fields (line 5 in the header and line 254 at the bottom) with different dates. This creates ambiguity about which date is authoritative for document freshness tracking.

📅 Recommendation

Since the standardized header at the top (line 5) now tracks document freshness, consider removing the duplicate field at the bottom to avoid confusion:

 
 ---
 
-**Last Updated**: 2026-01-23

Alternatively, if both dates serve different purposes, clarify their meanings (e.g., "Content last updated" vs. "Metadata last updated").

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@hyperfleet/docs/prow-cicd-cluster.md` at line 254, There are two "Last
Updated" fields in the document (the standardized header "Last Updated" at the
top and the duplicate "**Last Updated**: 2026-01-23" at the bottom); remove the
bottom duplicate line to avoid ambiguity, or if you intend different meanings,
rename the bottom label (e.g., "Content last updated" or "Metadata last
updated") and update its date accordingly so each field has a distinct purpose;
ensure references to "Last Updated" in the top header remain unchanged.
🧹 Nitpick comments (3)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (1)

3-9: Consolidate metadata to a single canonical section.

After adding Status/Owner/Last Updated, the document still has a second Metadata block (Line 12 onward). Keeping both creates ambiguity and future drift. Please merge these into one canonical header (or clearly rename the old block as historical authoring metadata).

As per coding guidelines, "-Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md`
around lines 3 - 9, The document contains duplicate metadata: the top header
with "Status/Owner/Last Updated" and a second "Metadata" block later;
consolidate them into a single canonical metadata section by merging the fields
("Status", "Owner", "Last Updated", etc.) into the header and removing the
redundant "Metadata" block (or clearly rename that later block to "Historical
Metadata" if preserving history), ensuring only one definitive metadata source
remains and updating any references to use the canonical header.
hyperfleet/test-release/git-and-release-strategy.md (1)

3-10: Unify metadata to prevent drift.

This new governance header coexists with the older Metadata block (Line 13 onward). Please consolidate so there is one source of truth for document metadata/freshness.

As per coding guidelines, "-Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@hyperfleet/test-release/git-and-release-strategy.md` around lines 3 - 10, The
document currently has two metadata sources—this new governance header using
"Status", "Owner", and "Last Updated" and an older "Metadata" block later—so
consolidate into a single canonical metadata section by merging values from the
"Metadata" block into the top governance header (or vice versa), remove the
redundant block, and ensure the final single source contains authoritative
fields "Status", "Owner", "Last Updated" (and any other keys from "Metadata") to
prevent drift and keep metadata fresh.
hyperfleet/test-release/add-clm-cd-job-in-prow.md (1)

3-10: Avoid duplicate document metadata blocks.

The new top-level governance metadata now overlaps with the existing Metadata section (Line 12 onward). Please keep one authoritative metadata section to prevent conflicting updates over time.

As per coding guidelines, "-Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@hyperfleet/test-release/add-clm-cd-job-in-prow.md` around lines 3 - 10, The
file contains duplicate top-level governance/metadata blocks (the new top-level
block and the existing "Metadata" section) which can cause conflicting updates;
remove the redundant block and retain a single authoritative metadata section
(merge any unique fields from the new block into the existing "Metadata"
section), ensure headings and keys are consistent, and update the document
header so only the canonical "Metadata" section remains.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 142-152: Update the commit examples to match the required format
declared by the header "Format: `HYPERFLEET-XXX - <type>: <subject>`": replace
any examples that start with just "chore:" (and any other examples missing the
ticket prefix) so they include a placeholder ticket prefix (e.g.,
"HYPERFLEET-XXX - chore: fix broken links in architecture-summary.md") and
ensure all example lines follow the exact "HYPERFLEET-XXX - <type>: <subject>"
pattern.

In
`@hyperfleet/components/adapter/maestro-cli-deprecated/maestro-adapter-integration-strategy.md`:
- Line 7: Edit the README text in maestro-adapter-integration-strategy.md to
replace the plain path reference "adapter/maestro-integration/" with a clickable
Markdown link (e.g.,
[adapter/maestro-integration/](adapter/maestro-integration/)) so readers can
click through directly; update the sentence that references the replacement
approach to use that Markdown link while keeping the rest of the deprecation
text intact.

In `@hyperfleet/components/sentinel/sentinel.md`:
- Around line 294-300: The YAML example block contains Markdown
header/description lines (`**Status**: Active`, `**Owner**`, `**Last Updated**`,
and the paragraph about the Sentinel service) inside the fenced yaml sample,
making it invalid; edit the fenced yaml sample so it only contains valid YAML
(start with keys like `resource_type: clusters`), and move the
metadata/description text (the bold Status/Owner/Last Updated lines and the
paragraph) out above or below the ```yaml``` block as normal Markdown prose;
locate the example by the `sentinel-config.yaml` comment and the `resource_type:
clusters` line to update the block.

In `@hyperfleet/mvp/mvp-working-agreement.md`:
- Around line 3-12: The document contains conflicting status metadata:
"**Status**: Historical" at the top and later "**Status**: Active"; pick a
single authoritative status and remove or annotate the other (for example, keep
"**Status**: Historical" and change the later "**Status**: Active" to
"**Previous status**: Active (as of October 31, 2024)" or delete the duplicate).
Update the header blocks (the lines containing "**Status**: Historical" and
"**Status**: Active") so only one clear status remains and ensure surrounding
metadata (Owner, Last Updated, Date) stays consistent with that chosen status.

In `@hyperfleet/test-release/test-release-MVP.md`:
- Around line 531-539: The fenced yaml example currently contains Markdown
metadata and prose (the lines with **Status**, **Owner**, **Last Updated** and
the descriptive paragraph) which makes the snippet invalid; move those Markdown
metadata lines and the descriptive paragraph out of the YAML code block into
normal Markdown above or below the snippet, and replace the fenced block with a
valid YAML snippet containing only proper YAML keys (e.g., keep apiVersion: v2
and add name: hyperfleet-api and description: HyperFleet API component inside a
```yaml ... ``` fence); update the example around the yaml snippet in
test-release-MVP.md so the yaml block contains just valid YAML (referencing
apiVersion: v2) and the historical metadata lines are plain Markdown outside the
code fence.

---

Outside diff comments:
In `@hyperfleet/docs/prow-cicd-cluster.md`:
- Line 254: There are two "Last Updated" fields in the document (the
standardized header "Last Updated" at the top and the duplicate "**Last
Updated**: 2026-01-23" at the bottom); remove the bottom duplicate line to avoid
ambiguity, or if you intend different meanings, rename the bottom label (e.g.,
"Content last updated" or "Metadata last updated") and update its date
accordingly so each field has a distinct purpose; ensure references to "Last
Updated" in the top header remain unchanged.

---

Nitpick comments:
In `@hyperfleet/test-release/add-clm-cd-job-in-prow.md`:
- Around line 3-10: The file contains duplicate top-level governance/metadata
blocks (the new top-level block and the existing "Metadata" section) which can
cause conflicting updates; remove the redundant block and retain a single
authoritative metadata section (merge any unique fields from the new block into
the existing "Metadata" section), ensure headings and keys are consistent, and
update the document header so only the canonical "Metadata" section remains.

In `@hyperfleet/test-release/git-and-release-strategy.md`:
- Around line 3-10: The document currently has two metadata sources—this new
governance header using "Status", "Owner", and "Last Updated" and an older
"Metadata" block later—so consolidate into a single canonical metadata section
by merging values from the "Metadata" block into the top governance header (or
vice versa), remove the redundant block, and ensure the final single source
contains authoritative fields "Status", "Owner", "Last Updated" (and any other
keys from "Metadata") to prevent drift and keep metadata fresh.

In
`@hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md`:
- Around line 3-9: The document contains duplicate metadata: the top header with
"Status/Owner/Last Updated" and a second "Metadata" block later; consolidate
them into a single canonical metadata section by merging the fields ("Status",
"Owner", "Last Updated", etc.) into the header and removing the redundant
"Metadata" block (or clearly rename that later block to "Historical Metadata" if
preserving history), ensuring only one definitive metadata source remains and
updating any references to use the canonical header.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 14fddd39-e4ca-41d5-acff-bc3f38b4b165

📥 Commits

Reviewing files that changed from the base of the PR and between a693ad8 and ae664d7.

📒 Files selected for processing (72)
  • CONTRIBUTING.md
  • README.md
  • hyperfleet/architecture/architecture-summary.md
  • hyperfleet/components/CLAUDE.md
  • hyperfleet/components/adapter/DNS-deprecated/GCP/README.md
  • hyperfleet/components/adapter/DNS-deprecated/GCP/cloud-dns-exploration.md
  • hyperfleet/components/adapter/DNS-deprecated/GCP/gcp-dns-adapter-spike-report.md
  • hyperfleet/components/adapter/PullSecret-deprecated/GCP/README.md
  • hyperfleet/components/adapter/PullSecret-deprecated/GCP/gcp-secret-manager-sdk-methods.md
  • hyperfleet/components/adapter/PullSecret-deprecated/GCP/pull-secret-requirements.md
  • hyperfleet/components/adapter/PullSecret-deprecated/GCP/pull-secret-service-ddr.md
  • hyperfleet/components/adapter/adapter-versioning.md
  • hyperfleet/components/adapter/framework/adapter-deployment.md
  • hyperfleet/components/adapter/framework/adapter-design-decisions.md
  • hyperfleet/components/adapter/framework/adapter-flow-diagrams.md
  • hyperfleet/components/adapter/framework/adapter-frame-design.md
  • hyperfleet/components/adapter/framework/adapter-integration-tests.md
  • hyperfleet/components/adapter/framework/adapter-metrics.md
  • hyperfleet/components/adapter/framework/adapter-status-contract.md
  • hyperfleet/components/adapter/framework/maestro-integration-guide.md
  • hyperfleet/components/adapter/hypershift-deprecated/GCP/README.md
  • hyperfleet/components/adapter/hypershift-deprecated/GCP/hypershift-controlplane-adapter-spike.md
  • hyperfleet/components/adapter/maestro-cli-deprecated/README.md
  • hyperfleet/components/adapter/maestro-cli-deprecated/maestro-adapter-integration-strategy.md
  • hyperfleet/components/adapter/maestro-cli-deprecated/maestro-cli-implementation.md
  • hyperfleet/components/adapter/maestro-integration/SPIKE-maestro-adapter-integration.md
  • hyperfleet/components/adapter/maestro-integration/maestro-architecture-introduction.md
  • hyperfleet/components/adapter/validation-deprecated/GCP/README.md
  • hyperfleet/components/adapter/validation-deprecated/GCP/gcp-validation-adapter-spike-report.md
  • hyperfleet/components/api-service/api-versioning.md
  • hyperfleet/components/api-service/post-mvp-actions.md
  • hyperfleet/components/broker/broker.md
  • hyperfleet/components/claude-code-plugin/claude-code-plugins-spike.md
  • hyperfleet/components/claude-code-plugin/plugin-brainstorming.md
  • hyperfleet/components/sentinel/sentinel-naming-strategy.md
  • hyperfleet/components/sentinel/sentinel-versioning.md
  • hyperfleet/components/sentinel/sentinel.md
  • hyperfleet/deployment/GKE/Quickstart.md
  • hyperfleet/deployment/GKE/README.md
  • hyperfleet/docs/prow-cicd-cluster.md
  • hyperfleet/docs/pull-secret-service-ddr.md
  • hyperfleet/docs/repository-creation-guidelines.md
  • hyperfleet/docs/sentinel-pulses.md
  • hyperfleet/docs/status-guide.md
  • hyperfleet/docs/versioning-trade-offs.md
  • hyperfleet/docs/wif-spike.md
  • hyperfleet/e2e-testing/e2e-run-strategy-spike-report.md
  • hyperfleet/e2e-testing/e2e-testing-framework-spike-report.md
  • hyperfleet/mvp/mvp-scope.md
  • hyperfleet/mvp/mvp-working-agreement.md
  • hyperfleet/standards/CLAUDE.md
  • hyperfleet/standards/commit-standard.md
  • hyperfleet/standards/configuration.md
  • hyperfleet/standards/container-image-standard.md
  • hyperfleet/standards/dependency-pinning.md
  • hyperfleet/standards/directory-structure.md
  • hyperfleet/standards/error-model.md
  • hyperfleet/standards/generated-code-policy.md
  • hyperfleet/standards/graceful-shutdown.md
  • hyperfleet/standards/health-endpoints.md
  • hyperfleet/standards/linting.md
  • hyperfleet/standards/logging-specification.md
  • hyperfleet/standards/makefile-conventions.md
  • hyperfleet/standards/metrics.md
  • hyperfleet/standards/tracing.md
  • hyperfleet/test-release/add-clm-cd-job-in-prow.md
  • hyperfleet/test-release/add-hyperfleet-e2e-ci-job-in-prow.md
  • hyperfleet/test-release/add-job-configuration-in-prow.md
  • hyperfleet/test-release/git-and-release-strategy.md
  • hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
  • hyperfleet/test-release/prow-vault-access-management.md
  • hyperfleet/test-release/test-release-MVP.md

**Owner**: HyperFleet Adapter Team
**Last Updated**: 2026-03-25

> Documents the original strategy for integrating adapters with Maestro via the Maestro CLI. Deprecated — the CLI-based integration approach was replaced by the Maestro SDK integration. See `adapter/maestro-integration/` for the current approach.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Make the replacement path a clickable Markdown link.

Deprecation guidance currently points to plain text (adapter/maestro-integration/), which is easy to miss or mistype. Please link it directly to the replacement doc/directory for reliable navigation.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@hyperfleet/components/adapter/maestro-cli-deprecated/maestro-adapter-integration-strategy.md`
at line 7, Edit the README text in maestro-adapter-integration-strategy.md to
replace the plain path reference "adapter/maestro-integration/" with a clickable
Markdown link (e.g.,
[adapter/maestro-integration/](adapter/maestro-integration/)) so readers can
click through directly; update the sentence that references the replacement
approach to use that Markdown link while keeping the rest of the deprecation
text intact.

Comment on lines 3 to 12
**Status**: Historical
**Owner**: HyperFleet MVP Team
**Last Updated**: 2026-03-25

> Defines the working agreements for the HyperFleet MVP development team of ~12 engineers across two global teams. Covers development process, code review norms, meeting cadence, and communication channels used during the MVP phase. This document is historical — the MVP is complete and team processes have evolved.

---

**Date**: October 31, 2024
**Status**: Active
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Resolve conflicting status metadata in the same document.

Line 3 marks the document as Historical, but Line 12 still says Status: Active. Please keep a single authoritative status or relabel the old one as historical context.

Proposed fix
-**Status**: Active
+**MVP Phase Status (as of 2024-10-31)**: Active

As per coding guidelines, "Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity."

📝 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
**Status**: Historical
**Owner**: HyperFleet MVP Team
**Last Updated**: 2026-03-25
> Defines the working agreements for the HyperFleet MVP development team of ~12 engineers across two global teams. Covers development process, code review norms, meeting cadence, and communication channels used during the MVP phase. This document is historical — the MVP is complete and team processes have evolved.
---
**Date**: October 31, 2024
**Status**: Active
**Status**: Historical
**Owner**: HyperFleet MVP Team
**Last Updated**: 2026-03-25
> Defines the working agreements for the HyperFleet MVP development team of ~12 engineers across two global teams. Covers development process, code review norms, meeting cadence, and communication channels used during the MVP phase. This document is historical — the MVP is complete and team processes have evolved.
---
**Date**: October 31, 2024
**MVP Phase Status (as of 2024-10-31)**: Active
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@hyperfleet/mvp/mvp-working-agreement.md` around lines 3 - 12, The document
contains conflicting status metadata: "**Status**: Historical" at the top and
later "**Status**: Active"; pick a single authoritative status and remove or
annotate the other (for example, keep "**Status**: Historical" and change the
later "**Status**: Active" to "**Previous status**: Active (as of October 31,
2024)" or delete the duplicate). Update the header blocks (the lines containing
"**Status**: Historical" and "**Status**: Active") so only one clear status
remains and ensure surrounding metadata (Owner, Last Updated, Date) stays
consistent with that chosen status.

@rh-amarin rh-amarin force-pushed the cleanup/ws1-ws2-ws3-structural-hygiene branch 4 times, most recently from 981ee1a to ad4db96 Compare March 25, 2026 07:47
Copy link
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 (2)
hyperfleet/components/adapter/deprecated/deprecated-DNS/cloud-dns-exploration.md (1)

2-9: LGTM! Clear deprecation notice added.

The deprecation header provides complete metadata (Status, Owner, Last Updated) and a clear explanation of why this exploration document is deprecated. The horizontal rule effectively separates the notice from the original content.

📝 Optional: Minor grammar improvement

Consider hyphenating the compound adjective for slightly better readability:

-> Exploration document from the GCP DNS adapter spike, investigating Cloud DNS API capabilities and integration options. Deprecated since GCP specific adapters will be developed by GCP team and out of scope for the core HyperFleet repositories
+> Exploration document from the GCP DNS adapter spike, investigating Cloud DNS API capabilities and integration options. Deprecated since GCP-specific adapters will be developed by the GCP team and are out of scope for the core HyperFleet repositories
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@hyperfleet/components/adapter/deprecated/deprecated-DNS/cloud-dns-exploration.md`
around lines 2 - 9, Hyphenate the compound adjective "GCP specific adapters" to
"GCP-specific adapters" in the deprecated exploration doc so the phrase reads
"...since GCP-specific adapters will be developed by GCP team..." — update the
text within the document body (search for the phrase "GCP specific adapters") to
use the hyphenated form for clarity.
hyperfleet/components/adapter/deprecated/deprecated-DNS/gcp-dns-adapter-spike-report.md (1)

2-9: LGTM! Deprecation header matches documentation pattern.

The deprecation notice follows the same consistent pattern as the exploration document, providing clear metadata and explanation. This consistency helps users quickly understand the status of deprecated GCP DNS artifacts.

📝 Optional: Same minor grammar improvement as companion file

For consistency with any updates to cloud-dns-exploration.md, consider:

-> Spike report from the GCP DNS adapter investigation, documenting findings, challenges, and recommendations from the exploration. Deprecated since GCP specific adapters will be developed by GCP team and out of scope for the core HyperFleet repositories
+> Spike report from the GCP DNS adapter investigation, documenting findings, challenges, and recommendations from the exploration. Deprecated since GCP-specific adapters will be developed by the GCP team and are out of scope for the core HyperFleet repositories
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@hyperfleet/components/adapter/deprecated/deprecated-DNS/gcp-dns-adapter-spike-report.md`
around lines 2 - 9, The deprecation header is fine and can be approved as-is; if
you want the optional minor grammar consistency with cloud-dns-exploration.md,
update the prose line containing "Deprecated since GCP specific adapters will be
developed by GCP team and out of scope for the core HyperFleet repositories" to
use "GCP-specific adapters" (hyphenate) and add a comma for clarity ("developed
by the GCP team, and out of scope...") in the gcp-dns-adapter-spike-report.md
document header.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In
`@hyperfleet/components/adapter/deprecated/deprecated-DNS/cloud-dns-exploration.md`:
- Around line 2-9: Hyphenate the compound adjective "GCP specific adapters" to
"GCP-specific adapters" in the deprecated exploration doc so the phrase reads
"...since GCP-specific adapters will be developed by GCP team..." — update the
text within the document body (search for the phrase "GCP specific adapters") to
use the hyphenated form for clarity.

In
`@hyperfleet/components/adapter/deprecated/deprecated-DNS/gcp-dns-adapter-spike-report.md`:
- Around line 2-9: The deprecation header is fine and can be approved as-is; if
you want the optional minor grammar consistency with cloud-dns-exploration.md,
update the prose line containing "Deprecated since GCP specific adapters will be
developed by GCP team and out of scope for the core HyperFleet repositories" to
use "GCP-specific adapters" (hyphenate) and add a comma for clarity ("developed
by the GCP team, and out of scope...") in the gcp-dns-adapter-spike-report.md
document header.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f4236000-4045-426e-bfba-8afade73c2de

📥 Commits

Reviewing files that changed from the base of the PR and between 981ee1a and ad4db96.

⛔ Files ignored due to path filters (5)
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/images/image1.png is excluded by !**/*.png
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/images/image2.png is excluded by !**/*.png
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/images/image3.png is excluded by !**/*.png
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/images/image4.png is excluded by !**/*.png
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/images/image5.png is excluded by !**/*.png
📒 Files selected for processing (69)
  • CONTRIBUTING.md
  • README.md
  • hyperfleet/architecture/architecture-summary.md
  • hyperfleet/components/CLAUDE.md
  • hyperfleet/components/adapter/adapter-versioning.md
  • hyperfleet/components/adapter/deprecated/deprecated-DNS/cloud-dns-exploration.md
  • hyperfleet/components/adapter/deprecated/deprecated-DNS/gcp-dns-adapter-spike-report.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/gcp-secret-manager-sdk-methods.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/pull-secret-requirements.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/pull-secret-service-ddr.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/pullsecret-adapter-config.yaml
  • hyperfleet/components/adapter/deprecated/deprecated-hypershift/hypershift-controlplane-adapter-spike.md
  • hyperfleet/components/adapter/deprecated/deprecated-maestro-cli/maestro-adapter-integration-strategy.md
  • hyperfleet/components/adapter/deprecated/deprecated-maestro-cli/maestro-cli-implementation.md
  • hyperfleet/components/adapter/deprecated/deprecated-validation/GCP/README.md
  • hyperfleet/components/adapter/deprecated/deprecated-validation/GCP/gcp-validation-adapter-spike-report.md
  • hyperfleet/components/adapter/framework/adapter-deployment.md
  • hyperfleet/components/adapter/framework/adapter-design-decisions.md
  • hyperfleet/components/adapter/framework/adapter-flow-diagrams.md
  • hyperfleet/components/adapter/framework/adapter-frame-design.md
  • hyperfleet/components/adapter/framework/adapter-integration-tests.md
  • hyperfleet/components/adapter/framework/adapter-metrics.md
  • hyperfleet/components/adapter/framework/adapter-status-contract.md
  • hyperfleet/components/adapter/framework/maestro-integration-guide.md
  • hyperfleet/components/adapter/maestro-integration/SPIKE-maestro-adapter-integration.md
  • hyperfleet/components/adapter/maestro-integration/maestro-architecture-introduction.md
  • hyperfleet/components/api-service/api-versioning.md
  • hyperfleet/components/api-service/post-mvp-actions.md
  • hyperfleet/components/broker/broker.md
  • hyperfleet/components/claude-code-plugin/claude-code-plugins-spike.md
  • hyperfleet/components/claude-code-plugin/plugin-brainstorming.md
  • hyperfleet/components/sentinel/sentinel-naming-strategy.md
  • hyperfleet/components/sentinel/sentinel-versioning.md
  • hyperfleet/components/sentinel/sentinel.md
  • hyperfleet/deployment/GKE/Quickstart.md
  • hyperfleet/deployment/GKE/README.md
  • hyperfleet/docs/prow-cicd-cluster.md
  • hyperfleet/docs/pull-secret-service-ddr.md
  • hyperfleet/docs/repository-creation-guidelines.md
  • hyperfleet/docs/sentinel-pulses.md
  • hyperfleet/docs/status-guide.md
  • hyperfleet/docs/versioning-trade-offs.md
  • hyperfleet/docs/wif-spike.md
  • hyperfleet/e2e-testing/e2e-run-strategy-spike-report.md
  • hyperfleet/e2e-testing/e2e-testing-framework-spike-report.md
  • hyperfleet/mvp/mvp-scope.md
  • hyperfleet/mvp/mvp-working-agreement.md
  • hyperfleet/standards/CLAUDE.md
  • hyperfleet/standards/commit-standard.md
  • hyperfleet/standards/configuration.md
  • hyperfleet/standards/container-image-standard.md
  • hyperfleet/standards/dependency-pinning.md
  • hyperfleet/standards/directory-structure.md
  • hyperfleet/standards/error-model.md
  • hyperfleet/standards/generated-code-policy.md
  • hyperfleet/standards/graceful-shutdown.md
  • hyperfleet/standards/health-endpoints.md
  • hyperfleet/standards/linting.md
  • hyperfleet/standards/logging-specification.md
  • hyperfleet/standards/makefile-conventions.md
  • hyperfleet/standards/metrics.md
  • hyperfleet/standards/tracing.md
  • hyperfleet/test-release/add-clm-cd-job-in-prow.md
  • hyperfleet/test-release/add-hyperfleet-e2e-ci-job-in-prow.md
  • hyperfleet/test-release/add-job-configuration-in-prow.md
  • hyperfleet/test-release/git-and-release-strategy.md
  • hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
  • hyperfleet/test-release/prow-vault-access-management.md
  • hyperfleet/test-release/test-release-MVP.md
✅ Files skipped from review due to trivial changes (60)
  • hyperfleet/standards/linting.md
  • hyperfleet/components/adapter/deprecated/deprecated-validation/GCP/gcp-validation-adapter-spike-report.md
  • hyperfleet/components/adapter/deprecated/deprecated-maestro-cli/maestro-cli-implementation.md
  • hyperfleet/components/adapter/deprecated/deprecated-validation/GCP/README.md
  • hyperfleet/components/adapter/framework/adapter-deployment.md
  • hyperfleet/test-release/prow-vault-access-management.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/pull-secret-service-ddr.md
  • hyperfleet/test-release/add-job-configuration-in-prow.md
  • hyperfleet/components/adapter/deprecated/deprecated-maestro-cli/maestro-adapter-integration-strategy.md
  • hyperfleet/deployment/GKE/README.md
  • hyperfleet/components/api-service/api-versioning.md
  • hyperfleet/components/sentinel/sentinel-versioning.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/pull-secret-requirements.md
  • hyperfleet/standards/makefile-conventions.md
  • hyperfleet/components/adapter/deprecated/deprecated-hypershift/hypershift-controlplane-adapter-spike.md
  • hyperfleet/test-release/add-hyperfleet-e2e-ci-job-in-prow.md
  • hyperfleet/components/adapter/framework/adapter-integration-tests.md
  • hyperfleet/standards/generated-code-policy.md
  • hyperfleet/e2e-testing/e2e-run-strategy-spike-report.md
  • hyperfleet/standards/dependency-pinning.md
  • hyperfleet/standards/health-endpoints.md
  • hyperfleet/deployment/GKE/Quickstart.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/gcp-secret-manager-sdk-methods.md
  • hyperfleet/components/adapter/maestro-integration/SPIKE-maestro-adapter-integration.md
  • hyperfleet/test-release/test-release-MVP.md
  • hyperfleet/docs/wif-spike.md
  • hyperfleet/components/sentinel/sentinel-naming-strategy.md
  • hyperfleet/components/adapter/framework/adapter-flow-diagrams.md
  • hyperfleet/components/sentinel/sentinel.md
  • hyperfleet/components/adapter/framework/maestro-integration-guide.md
  • hyperfleet/components/api-service/post-mvp-actions.md
  • hyperfleet/test-release/add-clm-cd-job-in-prow.md
  • hyperfleet/standards/tracing.md
  • hyperfleet/test-release/git-and-release-strategy.md
  • hyperfleet/standards/directory-structure.md
  • hyperfleet/e2e-testing/e2e-testing-framework-spike-report.md
  • hyperfleet/mvp/mvp-working-agreement.md
  • hyperfleet/components/claude-code-plugin/claude-code-plugins-spike.md
  • hyperfleet/components/claude-code-plugin/plugin-brainstorming.md
  • hyperfleet/standards/metrics.md
  • hyperfleet/docs/sentinel-pulses.md
  • hyperfleet/standards/graceful-shutdown.md
  • hyperfleet/components/CLAUDE.md
  • hyperfleet/components/adapter/framework/adapter-status-contract.md
  • hyperfleet/standards/commit-standard.md
  • hyperfleet/components/adapter/framework/adapter-frame-design.md
  • hyperfleet/mvp/mvp-scope.md
  • hyperfleet/docs/repository-creation-guidelines.md
  • hyperfleet/docs/prow-cicd-cluster.md
  • hyperfleet/architecture/architecture-summary.md
  • hyperfleet/components/broker/broker.md
  • hyperfleet/standards/container-image-standard.md
  • CONTRIBUTING.md
  • hyperfleet/docs/versioning-trade-offs.md
  • hyperfleet/docs/status-guide.md
  • hyperfleet/standards/configuration.md
  • hyperfleet/components/adapter/framework/adapter-design-decisions.md
  • hyperfleet/components/adapter/maestro-integration/maestro-architecture-introduction.md
  • hyperfleet/components/adapter/adapter-versioning.md
  • hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
🚧 Files skipped from review as they are similar to previous changes (6)
  • hyperfleet/standards/error-model.md
  • hyperfleet/standards/logging-specification.md
  • hyperfleet/standards/CLAUDE.md
  • hyperfleet/docs/pull-secret-service-ddr.md
  • hyperfleet/components/adapter/framework/adapter-metrics.md
  • README.md

WS1 - Structural Hygiene:
- Fix README.md structure diagram to match actual repo layout
- Fix broken links in architecture-summary.md (removed refs to non-existent
  component-architecture-diagram.md and data-flow-diagram.md)
- Update components/CLAUDE.md: add metadata header, add claude-code-plugin dir
- Update standards/CLAUDE.md: add metadata header, add helm-chart-conventions
- Fill README.md Contact section (remove //todo placeholders)
- Add CONTRIBUTING.md from template, adapted for architecture repo

WS2 - Document Standardization:
- Add Status/Owner/Last Updated metadata headers to 61 documents
- Add 2-4 sentence summaries to all documents
- Mark mvp-scope.md and mvp-working-agreement.md as Historical
- Add deprecation README to all 5 deprecated adapter directories
  (DNS-deprecated, PullSecret-deprecated, hypershift-deprecated,
   maestro-cli-deprecated, validation-deprecated)

WS3-A - Gap Filling:
- Create hyperfleet/components/broker/broker.md with full component design:
  topic/subscription model, CloudEvent format, pluggable broker abstraction,
  design decisions, trade-offs, alternatives considered, interfaces

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@rh-amarin rh-amarin force-pushed the cleanup/ws1-ws2-ws3-structural-hygiene branch from ad4db96 to 53cd706 Compare March 25, 2026 07:56
Copy link
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.

Actionable comments posted: 2

🧹 Nitpick comments (1)
hyperfleet/components/adapter/deprecated/deprecated-PullSecret/gcp-secret-manager-sdk-methods.md (1)

7-11: Tighten the deprecation note wording and remove duplicate separator.

Line 7 is a run-on sentence (“GCP specific” should be “GCP-specific”), and Lines 9/11 create back-to-back --- separators. Consider a concise rewrite and keep a single divider.

Suggested doc patch
- > Reference document for GCP Secret Manager SDK methods used during the pull secret adapter spike. Deprecated since GCP specific adapters will be developed by GCP team and out of scope for the core HyperFleet repositories
+ > Reference for GCP Secret Manager SDK methods used during the pull-secret adapter spike.  
+ > Deprecated: GCP-specific adapters will be developed by the GCP team and are out of scope for the core HyperFleet repositories.
 
 ---
-
 ---

As per coding guidelines, "Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@hyperfleet/components/adapter/deprecated/deprecated-PullSecret/gcp-secret-manager-sdk-methods.md`
around lines 7 - 11, Edit the deprecation note in the document referenced (the
deprecation header/first paragraph in
deprecated-PullSecret/gcp-secret-manager-sdk-methods.md): change the run-on
sentence to use "GCP-specific" (e.g., "Deprecated since GCP-specific adapters
will be developed by the GCP team and are out of scope for the core HyperFleet
repositories") and remove the duplicate '---' separators so only a single
divider remains; ensure the revised sentence is concise and grammatically
correct and replace the existing paragraph and separators accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@hyperfleet/components/adapter/deprecated/deprecated-DNS/cloud-dns-exploration.md`:
- Line 7: Update the user-facing sentence in the markdown document so the
compound adjective is hyphenated: replace the phrase "GCP specific adapters"
with "GCP-specific adapters" in the line that reads "Deprecated since GCP
specific adapters will be developed by GCP team and out of scope for the core
HyperFleet repositories" (look for that exact sentence in
cloud-dns-exploration.md).

In
`@hyperfleet/components/adapter/deprecated/deprecated-DNS/gcp-dns-adapter-spike-report.md`:
- Line 7: Replace the unhyphenated compound "GCP specific adapters" with the
hyphenated form "GCP-specific adapters" in the document text (look for the
phrase in the deprecated-DNS/gcp-dns-adapter-spike-report content, e.g., the
sentence starting "Spike report from the GCP DNS adapter investigation...");
update any other occurrences of the same compound in this file to use the
hyphenated form for correct grammar and consistency.

---

Nitpick comments:
In
`@hyperfleet/components/adapter/deprecated/deprecated-PullSecret/gcp-secret-manager-sdk-methods.md`:
- Around line 7-11: Edit the deprecation note in the document referenced (the
deprecation header/first paragraph in
deprecated-PullSecret/gcp-secret-manager-sdk-methods.md): change the run-on
sentence to use "GCP-specific" (e.g., "Deprecated since GCP-specific adapters
will be developed by the GCP team and are out of scope for the core HyperFleet
repositories") and remove the duplicate '---' separators so only a single
divider remains; ensure the revised sentence is concise and grammatically
correct and replace the existing paragraph and separators accordingly.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 037fd01b-26eb-4952-afe4-cc36c965e5a3

📥 Commits

Reviewing files that changed from the base of the PR and between ad4db96 and 53cd706.

⛔ Files ignored due to path filters (5)
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/images/image1.png is excluded by !**/*.png
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/images/image2.png is excluded by !**/*.png
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/images/image3.png is excluded by !**/*.png
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/images/image4.png is excluded by !**/*.png
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/images/image5.png is excluded by !**/*.png
📒 Files selected for processing (69)
  • CONTRIBUTING.md
  • README.md
  • hyperfleet/architecture/architecture-summary.md
  • hyperfleet/components/CLAUDE.md
  • hyperfleet/components/adapter/adapter-versioning.md
  • hyperfleet/components/adapter/deprecated/deprecated-DNS/cloud-dns-exploration.md
  • hyperfleet/components/adapter/deprecated/deprecated-DNS/gcp-dns-adapter-spike-report.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/gcp-secret-manager-sdk-methods.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/pull-secret-requirements.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/pull-secret-service-ddr.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/pullsecret-adapter-config.yaml
  • hyperfleet/components/adapter/deprecated/deprecated-hypershift/hypershift-controlplane-adapter-spike.md
  • hyperfleet/components/adapter/deprecated/deprecated-maestro-cli/maestro-adapter-integration-strategy.md
  • hyperfleet/components/adapter/deprecated/deprecated-maestro-cli/maestro-cli-implementation.md
  • hyperfleet/components/adapter/deprecated/deprecated-validation/GCP/README.md
  • hyperfleet/components/adapter/deprecated/deprecated-validation/GCP/gcp-validation-adapter-spike-report.md
  • hyperfleet/components/adapter/framework/adapter-deployment.md
  • hyperfleet/components/adapter/framework/adapter-design-decisions.md
  • hyperfleet/components/adapter/framework/adapter-flow-diagrams.md
  • hyperfleet/components/adapter/framework/adapter-frame-design.md
  • hyperfleet/components/adapter/framework/adapter-integration-tests.md
  • hyperfleet/components/adapter/framework/adapter-metrics.md
  • hyperfleet/components/adapter/framework/adapter-status-contract.md
  • hyperfleet/components/adapter/framework/maestro-integration-guide.md
  • hyperfleet/components/adapter/maestro-integration/SPIKE-maestro-adapter-integration.md
  • hyperfleet/components/adapter/maestro-integration/maestro-architecture-introduction.md
  • hyperfleet/components/api-service/api-versioning.md
  • hyperfleet/components/api-service/post-mvp-actions.md
  • hyperfleet/components/broker/broker.md
  • hyperfleet/components/claude-code-plugin/claude-code-plugins-spike.md
  • hyperfleet/components/claude-code-plugin/plugin-brainstorming.md
  • hyperfleet/components/sentinel/sentinel-naming-strategy.md
  • hyperfleet/components/sentinel/sentinel-versioning.md
  • hyperfleet/components/sentinel/sentinel.md
  • hyperfleet/deployment/GKE/Quickstart.md
  • hyperfleet/deployment/GKE/README.md
  • hyperfleet/docs/prow-cicd-cluster.md
  • hyperfleet/docs/pull-secret-service-ddr.md
  • hyperfleet/docs/repository-creation-guidelines.md
  • hyperfleet/docs/sentinel-pulses.md
  • hyperfleet/docs/status-guide.md
  • hyperfleet/docs/versioning-trade-offs.md
  • hyperfleet/docs/wif-spike.md
  • hyperfleet/e2e-testing/e2e-run-strategy-spike-report.md
  • hyperfleet/e2e-testing/e2e-testing-framework-spike-report.md
  • hyperfleet/mvp/mvp-scope.md
  • hyperfleet/mvp/mvp-working-agreement.md
  • hyperfleet/standards/CLAUDE.md
  • hyperfleet/standards/commit-standard.md
  • hyperfleet/standards/configuration.md
  • hyperfleet/standards/container-image-standard.md
  • hyperfleet/standards/dependency-pinning.md
  • hyperfleet/standards/directory-structure.md
  • hyperfleet/standards/error-model.md
  • hyperfleet/standards/generated-code-policy.md
  • hyperfleet/standards/graceful-shutdown.md
  • hyperfleet/standards/health-endpoints.md
  • hyperfleet/standards/linting.md
  • hyperfleet/standards/logging-specification.md
  • hyperfleet/standards/makefile-conventions.md
  • hyperfleet/standards/metrics.md
  • hyperfleet/standards/tracing.md
  • hyperfleet/test-release/add-clm-cd-job-in-prow.md
  • hyperfleet/test-release/add-hyperfleet-e2e-ci-job-in-prow.md
  • hyperfleet/test-release/add-job-configuration-in-prow.md
  • hyperfleet/test-release/git-and-release-strategy.md
  • hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
  • hyperfleet/test-release/prow-vault-access-management.md
  • hyperfleet/test-release/test-release-MVP.md
✅ Files skipped from review due to trivial changes (57)
  • hyperfleet/components/adapter/deprecated/deprecated-maestro-cli/maestro-cli-implementation.md
  • hyperfleet/docs/sentinel-pulses.md
  • hyperfleet/components/adapter/maestro-integration/maestro-architecture-introduction.md
  • hyperfleet/components/sentinel/sentinel-naming-strategy.md
  • hyperfleet/test-release/add-job-configuration-in-prow.md
  • hyperfleet/components/adapter/deprecated/deprecated-hypershift/hypershift-controlplane-adapter-spike.md
  • hyperfleet/components/sentinel/sentinel-versioning.md
  • hyperfleet/standards/container-image-standard.md
  • hyperfleet/components/adapter/framework/adapter-deployment.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/pull-secret-requirements.md
  • hyperfleet/components/adapter/framework/adapter-flow-diagrams.md
  • hyperfleet/deployment/GKE/Quickstart.md
  • hyperfleet/standards/dependency-pinning.md
  • hyperfleet/components/adapter/framework/maestro-integration-guide.md
  • hyperfleet/components/adapter/deprecated/deprecated-maestro-cli/maestro-adapter-integration-strategy.md
  • hyperfleet/components/adapter/deprecated/deprecated-validation/GCP/gcp-validation-adapter-spike-report.md
  • hyperfleet/components/adapter/framework/adapter-integration-tests.md
  • hyperfleet/components/adapter/adapter-versioning.md
  • hyperfleet/standards/health-endpoints.md
  • hyperfleet/architecture/architecture-summary.md
  • hyperfleet/components/adapter/deprecated/deprecated-PullSecret/pull-secret-service-ddr.md
  • hyperfleet/standards/metrics.md
  • hyperfleet/standards/generated-code-policy.md
  • hyperfleet/components/adapter/framework/adapter-status-contract.md
  • hyperfleet/standards/directory-structure.md
  • hyperfleet/standards/linting.md
  • hyperfleet/test-release/test-release-MVP.md
  • hyperfleet/standards/makefile-conventions.md
  • hyperfleet/components/CLAUDE.md
  • hyperfleet/standards/logging-specification.md
  • hyperfleet/mvp/mvp-working-agreement.md
  • hyperfleet/docs/versioning-trade-offs.md
  • hyperfleet/docs/wif-spike.md
  • hyperfleet/components/api-service/api-versioning.md
  • hyperfleet/standards/error-model.md
  • hyperfleet/components/adapter/framework/adapter-design-decisions.md
  • hyperfleet/test-release/prow-vault-access-management.md
  • hyperfleet/standards/configuration.md
  • hyperfleet/components/claude-code-plugin/claude-code-plugins-spike.md
  • hyperfleet/deployment/GKE/README.md
  • hyperfleet/test-release/add-hyperfleet-e2e-ci-job-in-prow.md
  • hyperfleet/components/claude-code-plugin/plugin-brainstorming.md
  • hyperfleet/test-release/add-clm-cd-job-in-prow.md
  • hyperfleet/e2e-testing/e2e-run-strategy-spike-report.md
  • hyperfleet/components/sentinel/sentinel.md
  • hyperfleet/components/api-service/post-mvp-actions.md
  • CONTRIBUTING.md
  • hyperfleet/components/adapter/framework/adapter-frame-design.md
  • hyperfleet/components/adapter/maestro-integration/SPIKE-maestro-adapter-integration.md
  • hyperfleet/components/adapter/deprecated/deprecated-validation/GCP/README.md
  • hyperfleet/standards/tracing.md
  • hyperfleet/docs/repository-creation-guidelines.md
  • hyperfleet/standards/commit-standard.md
  • hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
  • hyperfleet/docs/status-guide.md
  • hyperfleet/components/broker/broker.md
  • hyperfleet/standards/graceful-shutdown.md
🚧 Files skipped from review as they are similar to previous changes (7)
  • hyperfleet/test-release/git-and-release-strategy.md
  • hyperfleet/docs/prow-cicd-cluster.md
  • hyperfleet/e2e-testing/e2e-testing-framework-spike-report.md
  • hyperfleet/mvp/mvp-scope.md
  • hyperfleet/components/adapter/framework/adapter-metrics.md
  • README.md
  • hyperfleet/standards/CLAUDE.md

**Owner**: HyperFleet Adapter Team
**Last Updated**: 2026-03-25

> Spike report from the GCP DNS adapter investigation, documenting findings, challenges, and recommendations from the exploration. Deprecated since GCP specific adapters will be developed by GCP team and out of scope for the core HyperFleet repositories
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Hyphenate the compound adjective.

The phrase "GCP specific adapters" should be "GCP-specific adapters" for grammatical correctness in user-facing documentation.

📝 Proposed fix
-> Spike report from the GCP DNS adapter investigation, documenting findings, challenges, and recommendations from the exploration. Deprecated since GCP specific adapters will be developed by GCP team and out of scope for the core HyperFleet repositories
+> Spike report from the GCP DNS adapter investigation, documenting findings, challenges, and recommendations from the exploration. Deprecated since GCP-specific adapters will be developed by GCP team and out of scope for the core HyperFleet repositories
📝 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
> Spike report from the GCP DNS adapter investigation, documenting findings, challenges, and recommendations from the exploration. Deprecated since GCP specific adapters will be developed by GCP team and out of scope for the core HyperFleet repositories
> Spike report from the GCP DNS adapter investigation, documenting findings, challenges, and recommendations from the exploration. Deprecated since GCP-specific adapters will be developed by GCP team and out of scope for the core HyperFleet repositories
🧰 Tools
🪛 LanguageTool

[grammar] ~7-~7: Use a hyphen to join words.
Context: ...om the exploration. Deprecated since GCP specific adapters will be developed by G...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@hyperfleet/components/adapter/deprecated/deprecated-DNS/gcp-dns-adapter-spike-report.md`
at line 7, Replace the unhyphenated compound "GCP specific adapters" with the
hyphenated form "GCP-specific adapters" in the document text (look for the
phrase in the deprecated-DNS/gcp-dns-adapter-spike-report content, e.g., the
sentence starting "Spike report from the GCP DNS adapter investigation...");
update any other occurrences of the same compound in this file to use the
hyphenated form for correct grammar and consistency.

rh-amarin and others added 2 commits March 25, 2026 16:03
…ation

Verified broker.md against github.com/openshift-hyperfleet/hyperfleet-broker
and corrected multiple inaccuracies:

- Fix interface names: BrokerPublisher/BrokerSubscriber -> Publisher/Subscriber
- Fix Publisher.Publish signature: add missing topic string param, use *event.Event
- Add missing Publisher.Health(ctx context.Context) error method
- Fix Subscriber.Subscribe: add missing topic string param, correct HandlerFunc type
- Add missing Subscriber.Errors() <-chan *SubscriberError method
- Fix broker type value: "pubsub" -> "googlepubsub"; remove non-existent "stub" type
- Replace env-var ConfigMap config examples with actual broker.yaml YAML config
- Add Watermill as the underlying transport abstraction (key architectural fact)
- Add worker pool parallelism design decision (subscriber.parallelism config)
- Add repo link to hyperfleet-broker throughout

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Create hyperfleet/docs/glossary.md with definitions for all
HyperFleet-specific terms and abbreviations:
- Core concepts: Adapter, Sentinel, Broker, Cluster, NodePool
- Status model: Available/Applied/Health conditions, observed_generation
- Messaging: CloudEvent, Fan-out, Anemic Event, Subscription, Topic
- Configuration: AdapterConfig, broker.yaml, CEL, message_decision
- Architecture: v2 Architecture, Outbox Pattern (historical), Sharding
- Libraries: Watermill, hyperfleet-broker
- Process: Reconciliation, Idempotent, Technical Debt, ADR
- HyperFleet-specific: Pulse, Maestro, Landing Zone Adapter, HyperShift

Link glossary from README.md Navigation Guide.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
README.md Outdated
│ │ ├── PullSecret-deprecated/
│ │ ├── hypershift-deprecated/
│ │ ├── maestro-cli-deprecated/
│ │ └── validation-deprecated/
Copy link
Contributor

Choose a reason for hiding this comment

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

The tree here still shows the old deprecated directory names (DNS-deprecated/, PullSecret-deprecated/, etc.) at the adapter level, but the actual file renames in this PR move them under deprecated/deprecated-DNS/, deprecated/deprecated-PullSecret/, etc. Tree doesn't match what's on disk after merge.

Should be something like:

│   │   └── deprecated/
│   │       ├── deprecated-DNS/
│   │       ├── deprecated-PullSecret/
│   │       ├── deprecated-hypershift/
│   │       ├── deprecated-maestro-cli/
│   │       └── deprecated-validation/

(Also see the naming comment below on the deprecated- prefix.)


---

---
Copy link
Contributor

Choose a reason for hiding this comment

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

Double --- separators here. The new header adds one at line 9 and the original file already had one at line 11. Same thing in a few other files (gcp-secret-manager-sdk-methods.md, e2e-testing-framework-spike-report.md). Quick grep for back-to-back horizontal rules would catch these.

@@ -0,0 +1,35 @@
# Validation Adapter (GCP) — Deprecated
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor naming thing: the deprecated- prefix on every subdirectory feels redundant when they're already under deprecated/. deprecated/DNS/, deprecated/PullSecret/, etc. would read cleaner and avoid the stutter. Not a blocker, just worth considering.

rh-amarin and others added 9 commits March 26, 2026 09:21
Converts all document metadata headers from bold-text format to
YAML-style frontmatter delimited by `---` markers, as specified
by the updated root CLAUDE.md standard. Adds api-service.md component doc.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Reorders all markdown documents so the --- frontmatter block appears
as the very first content in the file, before the # title, following
proper YAML frontmatter convention. Updates root CLAUDE.md example
to reflect the correct structure. 83 files updated.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…te all links

Renames hyperfleet/architecture/architecture-summary.md to hyperfleet/README.md
per repository restructuring. Updates all internal and GitHub absolute links
across 13 files. Fixes 4 additional broken links where test-release docs had
moved to hyperfleet/docs/test-release/ but referencing files were not updated.

linkcheck passes — 86 files, 0 broken links.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Removes hyperfleet/architecture/ from all structure representations
(README.md, CLAUDE.md, CONTRIBUTING.md) now that architecture-summary.md
has moved to hyperfleet/README.md. Updates section headers, trees, and
document-type tables to reflect the current layout. Adds deprecated/
to CLAUDE.md and CONTRIBUTING.md trees.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@rh-amarin rh-amarin force-pushed the cleanup/ws1-ws2-ws3-structural-hygiene branch from 219eb8b to f4ea503 Compare March 26, 2026 17:56
rh-amarin and others added 4 commits March 26, 2026 19:24
Replaces the bulk-applied 2026-03-25 refactor date in every document's
frontmatter with the actual last-meaningful-commit date before a693ad8.
Dates sourced from git log for each file's original path (accounting for
files moved during the cleanup: test-release/, e2e-testing/, mvp/,
deployment/, and adapter deprecated directories). 72 files corrected.
Newly-created documents retain their 2026-03-25/26 creation dates.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
rh-amarin and others added 4 commits March 26, 2026 23:28
…-references

Removes content already covered in other canonical documents:
- Directory tree → references README.md
- Document header format → references CLAUDE.md
- Component/standards doc requirements → references components/CLAUDE.md and standards/CLAUDE.md
- Commit format details and examples → references commit-standard.md (already linked in step 4)
- Technical debt resolution format → removed (in components/CLAUDE.md)

Also removes stale link to deprecated-docs-structure-proposal.md (deleted in bcf5985)
from hyperfleet/deprecated/README.md.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Creates hyperfleet/adr/README.md with a minimal ADR template (Context,
Decision, Consequences, Alternatives table) and an ADR index. Updates
README.md and CLAUDE.md structure diagrams to include adr/, adds an ADR
entry to the README navigation guide, and fixes the stale adr path in
documentation.md (was docs/architecture/adr/, now hyperfleet/adr/).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@openshift-ci
Copy link

openshift-ci bot commented Mar 27, 2026

PR needs rebase.

Details

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 kubernetes-sigs/prow repository.

@openshift-ci
Copy link

openshift-ci bot commented Mar 27, 2026

@rh-amarin: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/linkcheck 98db46a link true /test linkcheck
ci/prow/yamllint 98db46a link true /test yamllint
ci/prow/markdownlint 98db46a link true /test markdownlint

Full PR test history. Your PR dashboard.

Details

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 kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants