From 265efb34adefd89d1223a1deada3122719abc4d8 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 23 Jan 2024 10:28:11 +0100 Subject: [PATCH 1/7] Add code owners for contributing folder --- .github/CODEOWNERS | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 55816fb999cb..c93011fdaf0b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -41,3 +41,4 @@ content/en/docs/kubernetes/helm/ @open-telemetry/docs-approvers @open-te content/en/docs/specs/ @open-telemetry/docs-approvers @open-telemetry/specs-approvers content/en/docs/security/ @open-telemetry/docs-approvers @open-telemetry/sig-security-maintainers content/en/ecosystem/demo/ @open-telemetry/demo-approvers @open-telemetry/demo-approvers +content/en/docs/contributing/ @open-telemetry/docs-approvers @open-telemetry/docs-maintainers \ No newline at end of file From b9054a7fb1b95e5158eff7776a037cc211df073f Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 23 Jan 2024 10:30:04 +0100 Subject: [PATCH 2/7] Remove two rows from style guide table --- content/en/docs/contributing/style-guide.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/content/en/docs/contributing/style-guide.md b/content/en/docs/contributing/style-guide.md index 9109823f7d1c..5e874ffd00d2 100644 --- a/content/en/docs/contributing/style-guide.md +++ b/content/en/docs/contributing/style-guide.md @@ -25,10 +25,8 @@ the site. | OpenTelemetry | OpenTelemetry should always be capitalized. Don't use Open-Telemetry. | | OTel | OTel is the accepted short form of OpenTelemetry. Don't use OTEL. | | Collector | When referring to the OpenTelemetry Collector, always capitalize Collector. | -| Repository | Code repository, lowercase when in the middle of a sentence. Don't use "repo" or "repos". | | OTEP | OpenTelemetry Enhancement Proposal. Write "OTEPs" as plural form. Don't write "OTep" or "otep". | | OpAMP | Open Agent Management Protocol. Don't write "OPAMP" or "opamp" in descriptions or instructions. | -| OTLP | OpenTelemetry Protocol. Don't write "OTlP" or "otlp" in descriptions or instructions. | Make sure that proper nouns, such as other CNCF projects or third-party tools, From 9b797b031e971d7a42ee71bc52d5ecfcc65af1bf Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 23 Jan 2024 10:34:30 +0100 Subject: [PATCH 3/7] Remove contribution-guidelines and add ignore for internal URL --- .htmltest.yml | 1 + content/en/docs/contribution-guidelines.md | 46 ---------------------- 2 files changed, 1 insertion(+), 46 deletions(-) delete mode 100644 content/en/docs/contribution-guidelines.md diff --git a/.htmltest.yml b/.htmltest.yml index ae4183a1884e..cb0599893192 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -8,6 +8,7 @@ TestFilesConcurrently: true IgnoreDirs: - ^blog/(\d+/)?page/\d+ IgnoreInternalURLs: # list of paths + - /docs/contribution-guidelines/ IgnoreURLs: # list of regexs of paths or URLs to be ignored - ^/docs/languages/\w+/(api|examples)/$ - ^/docs/languages/net/(metrics-api|traces-api)/ diff --git a/content/en/docs/contribution-guidelines.md b/content/en/docs/contribution-guidelines.md deleted file mode 100644 index a09510f1cd42..000000000000 --- a/content/en/docs/contribution-guidelines.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Contribution guidelines -description: How to contribute to OpenTelemetry -toc_hide: true ---- - -OpenTelemetry is an open source project, and we gladly accept new contributions -and contributors. See the CONTRIBUTING.md file in each SIG repository for -information on getting started. - -## Contribute to the OpenTelemetry Documentation - -To learn how to contribute fixes and new content to this project, read the -[Contributor's guide](/docs/contributing), which includes a style guide and -useful information on the review process. - -Individual SIGs may maintain documentation above and beyond what is offered -here, but we strive for accurate general guidance on using the project from our -main website. - -The per-language API, SDK, and "Getting Started" documentation is hosted in each -language's GitHub repository. For more information, -[see the Mirrored Documentation section](https://github.com/open-telemetry/opentelemetry.io/blob/main/CONTRIBUTING.md#mirrored-documentation) -of the website repository's CONTRIBUTING.md file. - -### Contributor License Agreement (CLA) - -Contributors to this and other OpenTelemetry projects require acceptance of our -CLA, managed by [EasyCLA](https://lfcla.com/). - -### Code reviews - -All submissions, including submissions by project members, require review. We -use GitHub pull requests for this purpose. Consult -[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more -information on using pull requests. - -### Getting started - -See [README.md](https://github.com/open-telemetry/opentelemetry.io#readme) for -current information. - -## Code of conduct - -OpenTelemetry follows the -[CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). From e093f0ba556163ae70f2b6921855f8750bc69cce Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 23 Jan 2024 10:37:34 +0100 Subject: [PATCH 4/7] Edit community-lists --- layouts/shortcodes/community-lists.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/layouts/shortcodes/community-lists.md b/layouts/shortcodes/community-lists.md index 399fe7ef1c3d..71947d990152 100644 --- a/layouts/shortcodes/community-lists.md +++ b/layouts/shortcodes/community-lists.md @@ -18,7 +18,7 @@ {{ template "community-links-list" . }} {{ end }} -{{ T "community_how_to" . }} {{ T "community_guideline" }}. +{{ T "community_how_to" . }} {{ T "community_guideline" }}. {{ define "community-links-list" -}} {{ range . }} From 4f4fd319a11dfa29ba96ebc4da0fb6093ee6c800 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 23 Jan 2024 10:51:55 +0100 Subject: [PATCH 5/7] Add remaining content --- content/en/docs/contributing/_index.md | 27 ++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index f4d471831a14..08a59f18cce8 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -537,7 +537,7 @@ Pull requests are merged when they comply with the following criteria: > **Important** > -> Do not worry too much about failing PR checks! Community members will help you +> Do not worry too much about failing PR checks. Community members will help you > to get them fixed, by either providing you with instructions how to fix them > or by fixing them on your behave. @@ -596,17 +596,19 @@ Keep the following in mind when filing an issue: ## Contribute to other repositories -The OpenTelemetry project contains many repositories. Several of these -repositories contain documentation: user-facing help text, error messages, API -references or code comments. +OpenTelemetry is an open source project, and we gladly accept new contributions +and contributors. See the CONTRIBUTING.md file in each SIG repository for +information on getting started. -If you see text you'd like to improve, use GitHub to search all repositories in -the OpenTelemetry organization. This can help you figure out where to submit -your issue or PR. +Individual SIGs may maintain documentation above and beyond what is offered +here, but we strive for accurate general guidance on using the project from our +main website. -Each repository has its own processes and procedures. Before you file an issue -or submit a PR, read that repository's `README.md`, `CONTRIBUTING.md`, and -`code-of-conduct.md`, if they exist. +If you see text you'd like to improve, use GitHub to search all +repositories in the OpenTelemetry organization. This can help you figure out +where to submit your issue or PR. Each repository has its own processes and +procedures. Before you file an issue or submit a PR, read that repository's +`README.md`, `CONTRIBUTING.md`, and `code-of-conduct.md`, if they exist. Most repositories use issue and PR templates. Have a look through some open issues and PRs to get a feel for that team's processes. Make sure to fill out @@ -621,3 +623,8 @@ the templates with as much detail as possible when you file issues or PRs. [dashboard]: https://app.netlify.com/sites/opentelemetry/overview [deploy preview]: https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/ + +## Code of conduct + +OpenTelemetry follows the +[CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). From 5725ddcbb076a25348d6befc2471146e1251468d Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 23 Jan 2024 10:58:16 +0100 Subject: [PATCH 6/7] Fix formatting --- content/en/docs/contributing/_index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index 08a59f18cce8..8ec8066b23be 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -602,13 +602,13 @@ information on getting started. Individual SIGs may maintain documentation above and beyond what is offered here, but we strive for accurate general guidance on using the project from our -main website. +main website. -If you see text you'd like to improve, use GitHub to search all -repositories in the OpenTelemetry organization. This can help you figure out -where to submit your issue or PR. Each repository has its own processes and -procedures. Before you file an issue or submit a PR, read that repository's -`README.md`, `CONTRIBUTING.md`, and `code-of-conduct.md`, if they exist. +If you see text you'd like to improve, use GitHub to search all repositories in +the OpenTelemetry organization. This can help you figure out where to submit +your issue or PR. Each repository has its own processes and procedures. Before +you file an issue or submit a PR, read that repository's `README.md`, +`CONTRIBUTING.md`, and `code-of-conduct.md`, if they exist. Most repositories use issue and PR templates. Have a look through some open issues and PRs to get a feel for that team's processes. Make sure to fill out From 986d47620a3db33c80bc760a315a9fd234125439 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 30 Jan 2024 10:43:58 +0100 Subject: [PATCH 7/7] Update .htmltest.yml Co-authored-by: Patrice Chalin --- .htmltest.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.htmltest.yml b/.htmltest.yml index cb0599893192..ae4183a1884e 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -8,7 +8,6 @@ TestFilesConcurrently: true IgnoreDirs: - ^blog/(\d+/)?page/\d+ IgnoreInternalURLs: # list of paths - - /docs/contribution-guidelines/ IgnoreURLs: # list of regexs of paths or URLs to be ignored - ^/docs/languages/\w+/(api|examples)/$ - ^/docs/languages/net/(metrics-api|traces-api)/