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.

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

Issue #4292 link to community guidelines at the top #4296

Merged
merged 6 commits into from
Apr 16, 2024

Conversation

ricardoamaro
Copy link
Contributor

Reference: #4292

The page under https://opentelemetry.io/docs/contributing/ talks about contributing to docs, although people might expect a page on how to contribute to the OpenTelemetry project in general. You have to read down a little bit to run into See also the general OpenTelemetry Contributor Guide, which provides details on the Contributor License Agreement and the Code of Conduct.

I think we should have this at the very top that this document is for contributing to docs and that the other document is where people find general guidelines.

@ricardoamaro ricardoamaro requested review from a team April 15, 2024 16:20
Copy link
Member

@svrnm svrnm left a comment

Choose a reason for hiding this comment

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

lgtm, thanks!

Copy link
Member

@theletterf theletterf left a comment

Choose a reason for hiding this comment

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

Couple nits — thanks!

content/en/docs/contributing/_index.md Outdated Show resolved Hide resolved
content/en/docs/contributing/_index.md Outdated Show resolved Hide resolved
You can open an issue about OpenTelemetry documentation, or contribute a change
This document is related to contributing do documentation.
If you are looking on how to contribute to the OpenTelemetry project in general see the
[OpenTelemetry Contributor Guide](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md)
Copy link
Member

Choose a reason for hiding this comment

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

could we also include a wording to indicate that every language implementation, collector, conventions repo has their own specific contributing guides as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is there also any place that aggregates all contributing guides?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added the wording

@svrnm svrnm merged commit 8a1dc73 into open-telemetry:main Apr 16, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants