Skip to content

docs: align dot-project docs with managed team flag convention - #673

Merged
riaankleinhans merged 1 commit into
cncf:mainfrom
RobertKielty:update-docs-with-managed-team-flag-convention
Sep 10, 2026
Merged

riaankleinhans merged 1 commit into
cncf:mainfrom
RobertKielty:update-docs-with-managed-team-flag-convention

Conversation

@RobertKielty

Copy link
Copy Markdown
Contributor

README.md, example/maintainers.yaml, and AGENT.md still referenced the old hard-required 'project-maintainers' team name and rule, which was superseded by PR #602 (managed flag for flexible resource provisioning). SCHEMA.md and template/maintainers.yaml were updated by that PR but these three files were missed.

  • README.md: update sample maintainers.yaml and required-team wording to describe the 'at least one managed team' rule and managed:false semantics (excluded from handle verification, mailing lists, service desk, Copilot seats).
  • example/maintainers.yaml: rename the Kubernetes example's required team from project-maintainers to maintainers, matching template/.
  • AGENT.md: update the sample maintainers config to use the maintainers team name and demonstrate an emeritus team with managed: false.

README.md, example/maintainers.yaml, and AGENT.md still referenced the
old hard-required 'project-maintainers' team name and rule, which was
superseded by PR cncf#602 (managed flag for flexible
resource provisioning). SCHEMA.md and template/maintainers.yaml were
updated by that PR but these three files were missed.

- README.md: update sample maintainers.yaml and required-team wording
  to describe the 'at least one managed team' rule and managed:false
  semantics (excluded from handle verification, mailing lists, service
  desk, Copilot seats).
- example/maintainers.yaml: rename the Kubernetes example's required
  team from project-maintainers to maintainers, matching template/.
- AGENT.md: update the sample maintainers config to use the maintainers
  team name and demonstrate an emeritus team with managed: false.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Robert Kielty <robert.kielty@cncf.io>
@RobertKielty
RobertKielty requested review from ahmadqasembader, jeefy and riaankleinhans and a balanced review from Copilot September 10, 2026 11:22
@RobertKielty RobertKielty self-assigned this Sep 10, 2026
@github-actions github-actions Bot added the needs-triage Indicates an issue or PR that has not been triaged yet (has a 'triage/foo' label applied) label Sep 10, 2026
@github-actions github-actions Bot added needs-kind Indicates an issue or PR that is missing an issue type or kind (a kind/foo label) needs-group Indicates an issue or PR that has not been assigned a group (toc or tag/foo label applied) needs-priority Indicates an issue or PR missing a priority label needs-area Indicates an issue or PR missing an area label needs-status Indicates an issue or PR missing a status label area/utilities Utilities and helper tools and removed needs-area Indicates an issue or PR missing an area label labels Sep 10, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The documentation consistently matches the implemented schema and validation behavior.

Pull request overview

Aligns dot-project documentation and examples with the managed-team convention.

Changes:

  • Replaces the legacy required team name.
  • Documents managed: false behavior.
  • Adds an unmanaged emeritus-team example.
File summaries
File Description
utilities/dot-project/README.md Documents managed-team requirements.
utilities/dot-project/example/maintainers.yaml Renames the example team.
utilities/dot-project/AGENT.md Updates agent guidance and example.
Review details
  • Files reviewed: 3/3 changed files
  • Comments generated: 0
  • Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@riaankleinhans
riaankleinhans merged commit 0b8a7f2 into cncf:main Sep 10, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/utilities Utilities and helper tools needs-group Indicates an issue or PR that has not been assigned a group (toc or tag/foo label applied) needs-kind Indicates an issue or PR that is missing an issue type or kind (a kind/foo label) needs-priority Indicates an issue or PR missing a priority label needs-status Indicates an issue or PR missing a status label needs-triage Indicates an issue or PR that has not been triaged yet (has a 'triage/foo' label applied)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants