Contributing

Learn how to contribute to OpenTelemetry documentation.

OpenTelemetry documentation contributors:

  • Improve existing content.
  • Create new content.
  • Update the OpenTelemetry Registry.
  • Improve the code that builds the site.

The following guides describe how to contribute to OpenTelemetry documentation.

For guidance on how to contribute to the OpenTelemetry project in general, see the OpenTelemetry Contributor Guide , which provides details on the Contributor License Agreement and the Code of Conduct. Every language implementation, Collector, and conventions repository has its own specific contributing guides.

Other ways to contribute


Requirements

To contribute, you need to be familiar with the following techs and tools.

Add new content

Learn how to add new content using GitHub UI or a local fork.

Documentation style guide

Terminology and style when writing OpenTelemetry docs.

Site localization

Creating and maintaining site pages in non-English localizations.

Blog

Learn how to submit a blog post.

Pull request checks

Learn how to make your pull request successfully pass all checks

Announcements

Create announcements or banners for special events.

Reporting an issue

How to report a bug, a security issue, or a potential improvement.

Development

Learn how to set up a development environment for the opentelemetry.io site.

SIG practices for approver and maintainers

Learn how approvers and maintainers manage issues and contributions.

Acknowledgements

Acknowledgements for sources for content on this site


Last modified August 7, 2024: Fix contributor guide URL (#4978) (30783526)