Skip to content

docs: add context files for agentic SDLC (LOG-9344)#267

Open
vparfonov wants to merge 1 commit intoViaQ:rh-mainfrom
vparfonov:log9344
Open

docs: add context files for agentic SDLC (LOG-9344)#267
vparfonov wants to merge 1 commit intoViaQ:rh-mainfrom
vparfonov:log9344

Conversation

@vparfonov
Copy link
Copy Markdown

@vparfonov vparfonov commented May 6, 2026

Create four comprehensive context files on rh-main to orient AI agents and developers to this Red Hat fork of Vector:

  • AGENTS.md: Fork-specific quick reference (branch selection, ocp-logging feature scope, patched crates, build commands, OWNERS, Jira conventions) with pointers to upstream docs for generic Vector development

  • CONTRIBUTING.md: Fork-focused contribution guide (branching strategy, PR process, code review, Jira conventions, upstream contribution workflow)

  • ARCHITECTURE.md: Fork architecture (deployment model, ocp-logging feature tables for both v0.47.0-rh and v0.54.0-rh, patched dependencies with rationale, build system, design decisions, upstream sync strategy)

  • CLAUDE.md: Stub pointing to AGENTS.md (matches dev branch pattern)

  • README.md: Updated with doc links, quick-start build snippet, v0.54.0-rh release entry, fixed formatting

All ocp-logging component lists (sources, transforms, sinks) verified against actual Cargo.toml on both dev branches. No upstream duplication — files reference upstream docs for generic Vector content. Upstream files on dev branches left untouched to avoid merge conflicts.

Fixes LOG-9344

Create four comprehensive context files on rh-main to orient AI agents and
developers to this Red Hat fork of Vector:

- AGENTS.md: Fork-specific quick reference (branch selection, ocp-logging
  feature scope, patched crates, build commands, OWNERS, Jira conventions)
  with pointers to upstream docs for generic Vector development

- CONTRIBUTING.md: Fork-focused contribution guide (branching strategy,
  PR process, code review, Jira conventions, upstream contribution workflow)

- ARCHITECTURE.md: Fork architecture (deployment model, ocp-logging feature
  tables for both v0.47.0-rh and v0.54.0-rh, patched dependencies with
  rationale, build system, design decisions, upstream sync strategy)

- CLAUDE.md: Stub pointing to AGENTS.md (matches dev branch pattern)

- README.md: Updated with doc links, quick-start build snippet, v0.54.0-rh
  release entry, fixed formatting

All ocp-logging component lists (sources, transforms, sinks) verified against
actual Cargo.toml on both dev branches. No upstream duplication — files
reference upstream docs for generic Vector content. Upstream files on dev
branches left untouched to avoid merge conflicts.

Fixes LOG-9344

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@vparfonov
Copy link
Copy Markdown
Author

/assign @jcantrill

@vparfonov
Copy link
Copy Markdown
Author

/hold

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 6, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: vparfonov
Once this PR has been reviewed and has the lgtm label, please assign jcantrill 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

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