From 5a197175fec1088da9d4f7171d6d763a6f3c8101 Mon Sep 17 00:00:00 2001 From: Ricardo Amaro Date: Mon, 15 Apr 2024 17:18:53 +0100 Subject: [PATCH 1/6] Issue #4292 link to community guidelines at the top --- 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 864531771913..6252a788ab75 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -6,7 +6,12 @@ weight: 200 cSpell:ignore: prepopulated spacewhite --- -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) +, which provides details on the Contributor License Agreement and the Code of +Conduct. + +For documentation, you can open an issue about OpenTelemetry, or contribute a change with a pull request (PR) to the [`opentelemetry.io` GitHub repository](https://github.com/open-telemetry/opentelemetry.io). @@ -17,11 +22,6 @@ OpenTelemetry documentation contributors: - Update the OpenTelemetry Registry. - Improve the code that builds the site. -See also the general -[OpenTelemetry Contributor Guide](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md) -, which provides details on the Contributor License Agreement and the Code of -Conduct. - ## Requirements To contribute, you need to be familiar with the following techs and tools: From 5367cfbd9c4510439fd9140a4b61a9e556a4b3f3 Mon Sep 17 00:00:00 2001 From: Ricardo Amaro Date: Mon, 15 Apr 2024 17:22:22 +0100 Subject: [PATCH 2/6] fix line --- content/en/docs/contributing/_index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index 6252a788ab75..cd3cc966d8dd 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -7,7 +7,8 @@ cSpell:ignore: prepopulated spacewhite --- 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) +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) , which provides details on the Contributor License Agreement and the Code of Conduct. From 6d7d0b292fd8144a648ce042af3d22eef961a9d7 Mon Sep 17 00:00:00 2001 From: Ricardo Amaro Date: Mon, 15 Apr 2024 19:39:45 +0100 Subject: [PATCH 3/6] Update content/en/docs/contributing/_index.md Co-authored-by: Fabrizio Ferri-Benedetti --- content/en/docs/contributing/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index cd3cc966d8dd..5f95be0db888 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -6,7 +6,7 @@ weight: 200 cSpell:ignore: prepopulated spacewhite --- -This document is related to contributing do documentation. +The following guide describes how to contribute to OpenTelemetry 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) , which provides details on the Contributor License Agreement and the Code of From 55ff4cd7405c1baa6cdc1e53a46d6fcbfeb7ffce Mon Sep 17 00:00:00 2001 From: Ricardo Amaro Date: Mon, 15 Apr 2024 19:39:53 +0100 Subject: [PATCH 4/6] Update content/en/docs/contributing/_index.md Co-authored-by: Fabrizio Ferri-Benedetti --- content/en/docs/contributing/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index 5f95be0db888..73ba7d4759ed 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -7,7 +7,7 @@ cSpell:ignore: prepopulated spacewhite --- The following guide describes how to contribute to OpenTelemetry documentation. -If you are looking on how to contribute to the OpenTelemetry project in general see the +For guidance 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) , which provides details on the Contributor License Agreement and the Code of Conduct. From 8c6882efc99d2910b989cc4ce2a3769aa57e3747 Mon Sep 17 00:00:00 2001 From: Ricardo Amaro Date: Mon, 15 Apr 2024 19:42:31 +0100 Subject: [PATCH 5/6] Update _index.md --- content/en/docs/contributing/_index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index 73ba7d4759ed..f8eb5426cb5f 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -11,6 +11,8 @@ For guidance on how to contribute to the OpenTelemetry project in general, see t [OpenTelemetry Contributor Guide](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md) , which provides details on the Contributor License Agreement and the Code of Conduct. +In extent, every language implementation, collector, and conventions +[repository](https://github.com/open-telemetry/) has their own specific contributing guides. For documentation, you can open an issue about OpenTelemetry, or contribute a change with a pull request (PR) to the From f92e9c4fe994ed79fc1d6e8eac43e4bcdc8d85e6 Mon Sep 17 00:00:00 2001 From: Ricardo Amaro Date: Mon, 15 Apr 2024 23:30:02 +0100 Subject: [PATCH 6/6] Code style fix --- content/en/docs/contributing/_index.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index f8eb5426cb5f..9b270696c47d 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -7,15 +7,16 @@ cSpell:ignore: prepopulated spacewhite --- The following guide describes how to contribute to OpenTelemetry documentation. -For guidance on how to contribute to the OpenTelemetry project in general, see the +For guidance 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) , which provides details on the Contributor License Agreement and the Code of -Conduct. -In extent, every language implementation, collector, and conventions -[repository](https://github.com/open-telemetry/) has their own specific contributing guides. +Conduct. In extent, every language implementation, collector, and conventions +[repository](https://github.com/open-telemetry/) has their own specific +contributing guides. -For documentation, you can open an issue about OpenTelemetry, or contribute a change -with a pull request (PR) to the +For documentation, you can open an issue about OpenTelemetry, or contribute a +change with a pull request (PR) to the [`opentelemetry.io` GitHub repository](https://github.com/open-telemetry/opentelemetry.io). OpenTelemetry documentation contributors: