open-telemetry / opentelemetry.io

Documentation and Blogging in OpenTelemetry.io

Overview

The documentation-website and blog repositories in OpenTelemetry.io are dedicated to maintaining the project’s documentation and blog content, respectively. These repositories are essential for providing clear and up-to-date information about the OpenTelemetry project and its components.

What is Documentation and Blogging?

Documentation

The documentation-website repository contains the source files for the OpenTelemetry project’s documentation. It is built using MkDocs and hosted on GitHub Pages. The documentation covers various topics, including getting started, concepts, guides, and reference material.

Blogging

The blog repository is where the OpenTelemetry team publishes blog posts related to the project. These posts can include announcements, tutorials, and other informative content. The blog is built using Jekyll and is also hosted on GitHub Pages.

Why is Documentation and Blogging important?

Documentation

Clear and comprehensive documentation is crucial for any project, especially one as complex as OpenTelemetry. It helps users understand the project’s goals, components, and usage. Good documentation also saves time for both the developers and the users by providing answers to common questions and reducing the need for support requests.

Blogging

Blogging is an effective way to share information and engage with the community. It allows the OpenTelemetry team to announce new features, provide tutorials, and share insights into the project’s development. Blogging also helps to build a strong community around the project by encouraging discussion and collaboration.

Contributing

Contributions to the documentation and blog are welcome! If you have a suggestion for an improvement or an addition to the documentation, please submit a pull request. For blog posts, you can also submit a proposal through the OpenTelemetry GitHub Discussions.

Documentation

To contribute to the documentation, follow these steps:

  1. Fork the documentation-website repository.
  2. Clone the forked repository to your local machine.
  3. Make your changes in the docs directory.
  4. Commit your changes and push them to your forked repository.
  5. Open a pull request against the original documentation-website repository.

Blogging

To submit a blog post proposal, follow these steps:

  1. Go to the OpenTelemetry GitHub Discussions.
  2. Start a new topic with a proposed title for your blog post.
  3. In the body of the topic, provide a brief summary of the content you plan to cover.
  4. The OpenTelemetry team will review your proposal and provide feedback.
  5. Once approved, you can write and submit your blog post following the instructions in the BLOG.md file in the blog repository.

For more information, please refer to the OpenTelemetry Contributing Guide.

Sources: