CNTRLPLANE-3735: docs: add AGENTS.md, ARCHITECTURE.md, CLAUDE.md, CONTRIBUTING.md; tri…

[tchap]

Add operator documentation for contributors and AI agents:

• AGENTS.md: quick-start reference (build, structure, conventions, pitfalls)
• ARCHITECTURE.md: data flow, startup sequence, static pod management, config observers
• CONTRIBUTING.md: code conventions, testing guidelines, PR process, OTE usage
• CLAUDE.md: thin wrapper pointing to AGENTS.md

Trim README tests section to pointers into CONTRIBUTING.md now that the detail lives there.

Summary by CodeRabbit

• Documentation
  • Added architecture documentation describing the scheduler operator’s components, workflows, and configuration handling.
  • Added contributor guidance covering development conventions, testing, reviews, and pull requests.
  • Added project guidance for builds, tests, structure, and development practices.
  • Updated the README to direct readers to the contribution guide for testing and contribution information.

[openshift-ci-robot]

@tchap: This pull request references CNTRLPLANE-3735 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set.

Details

In response to this:

…m README

Add operator documentation for contributors and AI agents:

• AGENTS.md: quick-start reference (build, structure, conventions, pitfalls)
• ARCHITECTURE.md: data flow, startup sequence, static pod management, config observers
• CONTRIBUTING.md: code conventions, testing guidelines, PR process, OTE usage
• CLAUDE.md: thin wrapper pointing to AGENTS.md

Trim README tests section to pointers into CONTRIBUTING.md now that the detail lives there.

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.

[coderabbitai]

Walkthrough

This change adds operator architecture and development guidance, introduces contribution and OTE testing documentation, links CLAUDE.md to AGENTS.md, and simplifies README.md testing and contribution sections.

Changes

Operator documentation

Layer / File(s)	Summary
Architecture reference ARCHITECTURE.md	Documents operator startup, data flow, namespaces, static-pod management, configuration rendering, controllers, and metrics.
Development and contribution guidance AGENTS.md, CONTRIBUTING.md	Adds project conventions, build and test commands, unsafe-edit rules, contribution requirements, review workflows, and OTE usage instructions.
Documentation entry points CLAUDE.md, README.md	References AGENTS.md from CLAUDE.md and redirects README testing and contribution guidance to CONTRIBUTING.md.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 15

✅ Passed checks (15 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title matches the main change by describing the new documentation files added in this PR.
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 only modifies docs (AGENTS.md, ARCHITECTURE.md, CLAUDE.md, CONTRIBUTING.md, README.md); no Ginkgo test titles were added or changed.
Test Structure And Quality	✅ Passed	PASS: The PR only changes documentation files; no Ginkgo test files or test logic were modified, so this test-quality check is not applicable.
Microshift Test Compatibility	✅ Passed	PR changes only markdown docs (AGENTS/ARCHITECTURE/CONTRIBUTING/CLAUDE/README); no new Ginkgo e2e tests or MicroShift-sensitive API usage to assess.
Single Node Openshift (Sno) Test Compatibility	✅ Passed	PR changes only markdown docs; no new or modified Ginkgo e2e tests were added, so the SNO test check is not applicable.
Topology-Aware Scheduling Compatibility	✅ Passed	Only markdown docs changed; no operator code, manifests, or scheduling logic was added, so no topology-sensitive scheduling constraints were introduced.
Ote Binary Stdout Contract	✅ Passed	Docs-only PR changes only markdown files; no runtime OTE binaries or suite setup code, so stdout contract isn't implicated.
Ipv6 And Disconnected Network Test Compatibility	✅ Passed	PR only changes markdown docs; no test/e2e files or Ginkgo specs were added, so there’s no IPv4/disconnected-network risk to assess.
No-Weak-Crypto	✅ Passed	The diff only adds/edits documentation, and a targeted scan of touched hunks found no MD5/SHA1/DES/RC4/3DES/Blowfish/ECB, custom crypto, or secret comparisons.
Container-Privileges	✅ Passed	PASS: The commit only adds/edits markdown docs (AGENTS/ARCHITECTURE/CLAUDE/CONTRIBUTING/README); no container/K8s manifests were changed.
No-Sensitive-Data-In-Logs	✅ Passed	Patch only adds docs; scans found no passwords, tokens, PII, session IDs, or internal/customer data in new logging-related text.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands.}

[openshift-ci]

[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 everettraven 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:

• OWNERS

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

[coderabbitai]

Actionable comments posted: 1

🤖 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.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 64-70: Rename the documentation files to lowercase:
CONTRIBUTING.md to contributing.md, ARCHITECTURE.md to architecture.md,
AGENTS.md to agents.md, and CLAUDE.md to claude.md. Update every cross-reference
to the renamed files, including the `@agents.md` pointer in claude.md, while
retaining the lowercase filename convention in contributing.md.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 2206d112-a118-4fb1-a28f-bf48e6c73538

📥 Commits

Reviewing files that changed from the base of the PR and between 56fa325 and 65a54a8.

📒 Files selected for processing (5)

• AGENTS.md
• ARCHITECTURE.md
• CLAUDE.md
• CONTRIBUTING.md
• README.md

[tchap]

Will trigger CI when this is reviewed. No point wasting money until then.