Skip to content

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

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

Open
LoveChauhan-18 wants to merge 3 commits into
base: main
Choose a base branch
from
+31 −9
Open

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

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77897d2
docs: better organisation of contributing info (#7278)
LoveChauhan-18 Mar 24, 2026
805efd1
fix: format content/en/docs/contributing/_index.md
LoveChauhan-18 Mar 27, 2026
7409eed
fix: update refcache.json with new contributing guide URLs
LoveChauhan-18 Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions content/en/docs/contributing/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,21 +56,22 @@ What do you want to do?

## 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

@vitorvasc vitorvasc Mar 25, 2026

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

@maryliag maryliag Mar 28, 2026

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


- **[Specification](https://github.com/open-telemetry/opentelemetry-specification)** - Cross-language requirements and expectations for all implementations. ([Contributing Guide](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CONTRIBUTING.md))
- **[Semantic Conventions](https://github.com/open-telemetry/semantic-conventions)** - Defines standard attribute names for telemetry data. ([Contributing Guide](https://github.com/open-telemetry/semantic-conventions/blob/main/CONTRIBUTING.md))
- **[Collector](https://github.com/open-telemetry/opentelemetry-collector)** - A vendor-agnostic proxy that can receive, process, and export telemetry data. ([Contributing Guide](https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md))
- **Language SDKs**: Every [language implementation repository][org] contains its own project-specific contributing guide.

For general guidance on contributing to the overall project, see the community [OpenTelemetry New Contributor Guide][].

If you would like to contribute to OpenTelemetry **documentation**, you can:

- Improve existing or create new content
- [Submit a blog post](blog/) or case study
- Add to or update the [OpenTelemetry Registry](/ecosystem/registry/)
- Improve the code that builds the site

The pages in this section describe how to contribute to OpenTelemetry
**documentation**.

For guidance on how to contribute to the OpenTelemetry project in general, see
the community [OpenTelemetry New Contributor Guide][]. Every [OTel
repository][org] for language implementations, the Collector, and conventions
have their own project-specific contributing guides.

[choose an issue]: issues/#fixing-an-existing-issue
[issues]: issues/
[OpenTelemetry New Contributor Guide]:
Expand Down
Loading