Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document documentation requirements for stable components #11852

Closed
Tracked by #11553
mx-psi opened this issue Dec 11, 2024 · 0 comments · Fixed by #11871
Closed
Tracked by #11553

Document documentation requirements for stable components #11852

mx-psi opened this issue Dec 11, 2024 · 0 comments · Fixed by #11871
Assignees
@mx-psi

Comments

@mx-psi
Copy link
Member

mx-psi commented Dec 11, 2024 •
edited
Loading

  • Configuration options must be documented
  • Feature gates must be documented
  • If producing predictable telemetry, it must be documented
This was referenced Dec 11, 2024
Open
Merged
@mx-psi mx-psi moved this from Todo to Waiting for reviews in Collector: v1 Dec 16, 2024
@mx-psi mx-psi self-assigned this Dec 16, 2024
github-merge-queue bot pushed a commit that referenced this issue Jan 22, 2025
@mx-psi
[chore][docs/component-stability.md] Add documentation requirements f…
54c3cd8 
…or components based on their stability level (#11871)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

<!-- Issue number if applicable -->

Adds requirements for documentation for different stability levels.

I expect many of these will be done through automation over time :)

#### Link to tracking issue

Fixes #11852
@github-project-automation github-project-automation bot moved this from Waiting for reviews to Done in Collector: v1 Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mx-psi mx-psi

Labels
None yet
Projects
Collector: v1
Status: Done
Milestone
No milestone
1 participant
@mx-psi