Skip to content

docs: add explicit project links to contributing index (#7278)#9493

Open
LoveChauhan-18 wants to merge 3 commits intoopen-telemetry:mainfrom
LoveChauhan-18:fix/contributing-info-7278
Open

docs: add explicit project links to contributing index (#7278)#9493
LoveChauhan-18 wants to merge 3 commits intoopen-telemetry:mainfrom
LoveChauhan-18:fix/contributing-info-7278

Conversation

@LoveChauhan-18
Copy link
Copy Markdown

@LoveChauhan-18 LoveChauhan-18 commented Mar 24, 2026

  • I have read and followed the Contributing docs, especially the "First-time contributing?" section.
  • This PR has content that I did not fully write myself.
  • I have the experience and knowledge necessary to understand, review, and validate all content in this PR.1

Fixes #7278

This PR updates the "What can I contribute to?" section in the contributing _index.md to directly list the main OpenTelemetry repositories (Specification, Semantic Conventions, Collector, and Language SDKs).

Previously, users had to dig through the general community repo or specs to find where to contribute (like the semconv docs). This change surfaces the specific repository links right in the navigation, making them much easier to discover for new contributors.

Footnotes

  1. Yes, I can answer maintainer questions about the content of this PR, without using AI.

@LoveChauhan-18 LoveChauhan-18 requested a review from a team as a code owner March 24, 2026 19:50
@otelbot-docs otelbot-docs bot requested a review from a team March 25, 2026 11:39
@otelbot-docs otelbot-docs bot added the missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer label Mar 25, 2026
## What can I contribute to?

OpenTelemetry documentation contributors:
If you want to contribute to the core OpenTelemetry projects, here is a list of the main repositories:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I feel we can discuss this further before merging, as per @svrnm's comment. Personally, I also like the idea of keeping this section clean and focused on documentation contributions.

Instead, we could expand the contribution possibilities by creating a new page/section (maybe /community/contribute?) that includes this list, the overall guidelines, and other content that is currently available only through the community repo. WDYT?

/cc @open-telemetry/docs-approvers

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.

I don't think this should be added here. There are even more repos that were mentioned here, so this could make it sound the missing ones are not "worth it", which is not true. Also, new repos are being created every now and then and keeping this up to date could be challenging. One option would be to link to the github page that list all otel repos, keeping it generic, and mentioning each one has a tab for "contributing" and more specific details can be found on them

@otelbot-docs otelbot-docs bot requested a review from a team March 27, 2026 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Better organisation/consolidation of contributing info

3 participants