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

Add status header to all components #5375

Closed
8 tasks done
codeboten opened this issue May 17, 2022 · 0 comments · Fixed by #5435
Closed
8 tasks done

Add status header to all components #5375

codeboten opened this issue May 17, 2022 · 0 comments · Fixed by #5435
Labels
area:documentation good first issue Good for newcomers help wanted Good issue for contributors to OpenTelemetry Service to pick up

Comments

@codeboten
Copy link
Contributor

codeboten commented May 17, 2022 •
edited
Loading

In an effort to make finding the state of each component easier, the README for each component should contain a table which includes:

  • stability level
  • supported pipelines
  • distributions which contain the component

See open-telemetry/opentelemetry-collector-contrib#10006 for an example table with embedded links:

| Status                   |           |
| ------------------------ | --------- |
| Stability                | [beta]    |
| Supported pipeline types | traces    |
| Distributions            | [contrib] |

<README contents>

[beta]: https://github.com/open-telemetry/opentelemetry-collector-contrib#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

Exporters

Extensions

Processors

Receivers
@codeboten codeboten added help wanted Good issue for contributors to OpenTelemetry Service to pick up good first issue Good for newcomers area:documentation labels May 17, 2022
codeboten pushed a commit to codeboten/opentelemetry-collector that referenced this issue May 26, 2022
[docs] add status header for ballast/zpages
b4090ae 
Fixes open-telemetry#5375
Fixes open-telemetry#5429
Fixes open-telemetry#5428
@codeboten codeboten mentioned this issue May 26, 2022
Merged
codeboten pushed a commit that referenced this issue May 26, 2022
[docs] add status header for ballast/zpages (#5435)
79b7835 
Fixes #5375
Fixes #5429
Fixes #5428
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area:documentation good first issue Good for newcomers help wanted Good issue for contributors to OpenTelemetry Service to pick up
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[docs] add status header for ballast/zpages codeboten/opentelemetry-collector
1 participant
@codeboten