Skip to content

Commit 7db5cc2

Browse files
authored
Merge branch 'main' into docs/contributing
2 parents b441c58 + f15873c commit 7db5cc2

File tree

12 files changed

+98
-48
lines changed

12 files changed

+98
-48
lines changed

.github/workflows/auto-update-community-members.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
jobs:
1010
auto-update-versions:
1111
name: Auto-update community members page
12-
runs-on: ubuntu-24.04
12+
runs-on: ubuntu-latest
1313
# Remove the if statement below when testing against a fork
1414
if: github.repository == 'open-telemetry/opentelemetry.io'
1515
steps:

.github/workflows/auto-update-registry.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
jobs:
1010
auto-update-versions:
1111
name: Auto-update registry versions
12-
runs-on: ubuntu-20.04
12+
runs-on: ubuntu-latest
1313
# Remove the if statement below when testing against a fork
1414
if: github.repository == 'open-telemetry/opentelemetry.io'
1515
steps:

.github/workflows/auto-update-versions.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
jobs:
1010
auto-update-versions:
1111
name: Auto-update versions
12-
runs-on: ubuntu-20.04
12+
runs-on: ubuntu-latest
1313
if: github.repository == 'open-telemetry/opentelemetry.io'
1414
env:
1515
DEPTH: --depth 999 # submodule clone depth

content/en/docs/contributing/localization.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ at `HEAD`, then erase the commit hash value in the front matter, and run the
210210
{{% /alert %}}
211211

212212
If you have batch updated all of your localization pages that had drifted, you
213-
can update the commit hash of these files using the `-u` flag followed by a
213+
can update the commit hash of these files using the `-c` flag followed by a
214214
commit hash or 'HEAD' to use `main@HEAD`.
215215

216216
```sh

content/en/docs/contributing/pr-checks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ a set of checks are executed. The PR checks verify that...
1919
{{% alert title="Note" color="primary" %}}
2020

2121
If any of the PR checks fails, try to
22-
[fix content issues automatically](../pull-requests/#fix-content-issues-automatically)
23-
first by running `npm run fix:all` on your machine.
22+
[fix content issues automatically](../pull-requests/#fix-issues) first by
23+
running `npm run fix:all` on your machine.
2424

2525
Additionally, you can comment `/fix:all` on your Pull Request. This will make
2626
the OpenTelemetry Bot run those commands on your behalf and update the PR. Make

content/en/docs/contributing/pull-requests.md

+62-32
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,28 @@
11
---
22
title: Submitting content
33
description:
4-
Learn how to submit new or changed content using the GitHub UI or a local
4+
Learn how to submit new or changed content using the GitHub UI or from a local
55
fork.
66
aliases: [new-content]
77
weight: 15
88
---
99

10-
To contribute new or improve existing documentation content, submit a [pull
11-
request][PR] (PR):
10+
To contribute new or improve existing documentation, submit a [pull request][PR]
11+
(PR):
1212

13-
- If your change is small, or you're unfamiliar with Git, see
14-
[Changes using GitHub](#changes-using-github) to learn how to edit a page.
15-
- If your changes are large, see [Work from a local fork](#fork-the-repo) to
16-
learn how to make changes locally on your computer.
13+
- If your change is small, or you're unfamiliar with [Git], see
14+
[Using GitHub](#changes-using-github) to learn how to edit a page.
15+
- Otherwise, see [Work from a local fork](#fork-the-repo) to learn how to make
16+
changes in your own local development environment.
17+
18+
{{% alert title="Contributor License Agreement (CLA)" color=warning %}}
19+
20+
All contributors are required to [sign a Contributor License Agreement
21+
(CLA)][CLA] before changes can be reviewed and merged.
22+
23+
[CLA]: ../prerequisites/#cla
24+
25+
{{% /alert %}}
1726

1827
{{% alert title="Tip: Draft status" %}}
1928

@@ -47,20 +56,13 @@ class first,second white
4756

4857
_Figure 1. Contributing new content._
4958

50-
## Changes using GitHub {#changes-using-github}
51-
52-
If you're less experienced with Git workflows, here's an easier method of
53-
creating and submitting a pull request. Figure 2 outlines the steps and the
54-
details follow.
55-
56-
{{% alert title="Contributor License Agreement (CLA)" color=warning %}}
57-
58-
All contributors are required to [sign a Contributor License Agreement
59-
(CLA)][CLA] before changes can be approved and merged.
59+
## Using GitHub {#changes-using-github}
6060

61-
[CLA]: ../prerequisites/#cla
61+
### Edit and submit changes from your browser {#page-edit-from-browser}
6262

63-
{{% /alert %}}
63+
If you're less experienced with Git workflows, here's an easier method of
64+
preparing and opening a new pull request (PR). Figure 2 outlines the steps and
65+
the details follow.
6466

6567
```mermaid
6668
flowchart LR
@@ -124,21 +126,47 @@ If a reviewer asks you to make changes:
124126
When your review is complete, a reviewer merges your PR and your changes goes
125127
live a few minutes later.
126128

127-
{{% alert title="Tip" %}}
129+
### Fixing PR check failures {#fixing-prs-in-github}
130+
131+
After you've submitted a PR, GitHub runs some build checks. Certain check
132+
failures, like formatting issues, can be fixed automatically.
133+
134+
Add the following comment to your PR:
135+
136+
```text
137+
/fix:all
138+
```
139+
140+
This will trigger the OpenTelemetry bot to try to fix build issues. Or you can
141+
issue one of the following fix commands to address a specific failure:
142+
143+
```text
144+
fix:dict
145+
fix:expired
146+
fix:filenames
147+
fix:format
148+
fix:htmltest-config
149+
fix:i18n
150+
fix:markdown
151+
fix:refcache
152+
fix:submodule
153+
fix:text
154+
```
155+
156+
{{% alert title="Pro tip" %}}
128157

129-
Comment `/fix:format` on your pull request to trigger an automated check for
130-
formatting issues.
158+
You can also run the `fix` commands locally. For the complete list of fix
159+
commands, run `npm run -s '_list:fix:*'`.
131160

132161
{{% /alert %}}
133162

134-
## Work from a local fork {#fork-the-repo}
163+
## Working locally {#fork-the-repo}
135164

136165
If you're more experienced with Git, or if your changes are larger than a few
137166
lines, work from a local fork.
138167

139-
Make sure you have
140-
[git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed
141-
on your computer. You can also use a user interface for Git.
168+
Make sure you have [`git` installed] on your computer. You can also use a user
169+
interface for Git.
142170

143171
Figure 3 shows the steps to follow when you work from a local fork. The details
144172
for each step follow.
@@ -170,14 +198,14 @@ class changes,changes2 white
170198

171199
_Figure 3. Working from a local fork to make your changes._
172200

173-
### Fork the opentelemetry.io repository
201+
### Fork the repository
174202

175203
1. Navigate to the
176204
[`opentelemetry.io`](https://github.com/open-telemetry/opentelemetry.io/)
177205
repository.
178206
1. Select **Fork**.
179207

180-
### Create a local clone and set the upstream
208+
### Clone and set upstream
181209

182210
1. In a terminal window, clone your fork and install the requirements:
183211

@@ -280,7 +308,7 @@ When you are ready to submit a pull request, commit your changes.
280308

281309
1. Once the changes are pushed, GitHub lets you know that you can create a PR.
282310

283-
### Open a pull request from your fork {#open-a-pr}
311+
### Open a new PR {#open-a-pr}
284312

285313
Figure 4 shows the steps to open a PR from your fork to
286314
[opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io).
@@ -346,7 +374,7 @@ using [Netlify](https://www.netlify.com/).
346374

347375
Other checks might also fail. See the [list of all PR checks](../pr-checks).
348376

349-
### Fix content issues automatically
377+
### Fix issues {#fix-issues}
350378

351379
Before submitting a change to the repository, run the following command and (i)
352380
address any reported issues, (ii) commit any files changed by the script:
@@ -365,7 +393,7 @@ npm run fix:all # May update files
365393
To list available NPM scripts, run `npm run`. See [PR checks](../pr-checks) for
366394
more information on pull request checks and how to fix errors automatically.
367395

368-
### Preview your changes locally {#preview-locally}
396+
### Preview your changes {#preview-locally}
369397

370398
Preview your changes locally before pushing them or opening a pull request. A
371399
preview lets you catch build errors or markdown formatting problems.
@@ -376,7 +404,7 @@ To build and serve the site locally with Hugo, run the following command:
376404
npm run serve
377405
```
378406

379-
Navigate to `http://localhost:1313` in your web browser to see the local
407+
Navigate to <http://localhost:1313> in your web browser to see the local
380408
preview. Hugo watches for changes and rebuilds the site as needed.
381409

382410
To stop the local Hugo instance, go back to the terminal and type `Ctrl+C`, or
@@ -513,4 +541,6 @@ Pull requests are merged when they comply with the following criteria:
513541
[dashboard]: https://app.netlify.com/sites/opentelemetry/overview
514542
[deploy preview]:
515543
https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/
544+
[Git]: https://docs.github.com/en/get-started/using-git/about-git
545+
[`git` installed]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
516546
[PR]: https://docs.github.com/en/pull-requests

content/en/docs/platforms/kubernetes/helm/operator.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ generate/configure the required TLS certificate.
4242

4343
- The easiest and default method is to install the
4444
[cert-manager](https://cert-manager.io/docs/) and set
45-
`admissionWebhooks.certManager.create` to `true`. In this way, cert-manager
45+
`admissionWebhooks.certManager.enabled` to `true`. In this way, cert-manager
4646
will generate a self-signed certificate. See
4747
[cert-manager installation](https://cert-manager.io/docs/installation/kubernetes/)
4848
for more details.

content/es/docs/contributing/pull-requests.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description:
44
Aprende a agregar contenido nuevo utilizando la interfaz de GitHub o desde tu
55
editor de código.
66
weight: 2
7-
default_lang_commit: f724c15be360e5059fb89e696d9a5cc8d00496f6
7+
default_lang_commit: f724c15be360e5059fb89e696d9a5cc8d00496f6 # patched
88
cSpell:ignore: aplícala solucionándolas vincúlalos
99
---
1010

@@ -345,7 +345,7 @@ implementar una vista previa usando [Netlify](https://www.netlify.com/).
345345
También pueden fallar otras comprobaciones. Consulta la
346346
[lista de todas las comprobaciones de PR](/docs/contributing/pr-checks).
347347

348-
### Soluciona problemas de contenido automáticamente {#fix-content-issues-automatically}
348+
### Soluciona problemas de contenido automáticamente {#fix-issues}
349349

350350
Antes de enviar un cambio al repositorio, ejecuta el siguiente comando y (i)
351351
aborda los problemas informados, (ii) confirma los archivos modificados por el

content/ja/docs/contributing/pull-requests.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: コンテンツの提出
33
description: GitHub UI またはローカルのフォークを利用して、新しいコンテンツまたはコンテンツの変更を提出する方法を学びます
44
aliases: [new-content]
55
weight: 15
6-
default_lang_commit: 99f0ae5760038d51f9e9eb376bb428a2caca8167
6+
default_lang_commit: 99f0ae5760038d51f9e9eb376bb428a2caca8167 # patched
77
---
88

99
新しいドキュメントの内容を追加したり、既存のコンテンツの改善をするには、[プルリクエスト][PR] (PR)を提出してください。
@@ -313,7 +313,7 @@ PR を公開した後に、自動テストの実行と [Netlify](https://www.net
313313

314314
他のチェックも同様に失敗している可能性があります。[すべての PR チェック](../pr-checks) を参照してください。
315315

316-
### 内容の問題を自動的に修正する {#fix-content-issues-automatically}
316+
### 内容の問題を自動的に修正する {#fix-issues}
317317

318318
リポジトリに変更を提出するまえに、以下のコマンドを実行して (i) 報告された問題の対応し、(ii) スクリプトによって変更されたファイルのコミットをしてください。
319319

data/ecosystem/distributions.yaml

+8
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@
77
url: https://aws.amazon.com/otel/
88
docsUrl: https://aws-otel.github.io/docs/getting-started/collector
99
components: [Collector]
10+
- name: AWS AWS Distro for OpenTelemetry - Instrumentation for JavaScript
11+
url: https://github.com/aws-observability/aws-otel-js
12+
docsUrl: https://github.com/aws-observability/aws-otel-js
13+
components: [Node]
14+
- name: AWS AWS Distro for OpenTelemetry - Instrumentation for Python
15+
url: https://github.com/aws-observability/aws-otel-python
16+
docsUrl: https://github.com/aws-observability/aws-otel-python
17+
components: [Python]
1018
- name: Grafana Alloy
1119
url: https://github.com/grafana/alloy
1220
docsUrl: https://grafana.com/docs/alloy/latest/

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@
129129
"markdownlint": "^0.37.4",
130130
"markdownlint-cli2": "^0.17.2",
131131
"postcss-cli": "^11.0.0",
132-
"prettier": "3.4.2",
132+
"prettier": "3.5.0",
133133
"puppeteer": "^24.2.0",
134134
"require-dir": "^1.2.0",
135135
"textlint": "^14.4.2",

static/refcache.json

+16-4
Original file line numberDiff line numberDiff line change
@@ -1139,6 +1139,10 @@
11391139
"StatusCode": 206,
11401140
"LastSeen": "2025-02-01T07:12:03.67448-05:00"
11411141
},
1142+
"https://docs.github.com/en/get-started/using-git/about-git": {
1143+
"StatusCode": 206,
1144+
"LastSeen": "2025-02-11T08:05:07.564567-05:00"
1145+
},
11421146
"https://docs.github.com/en/pull-requests": {
11431147
"StatusCode": 206,
11441148
"LastSeen": "2024-09-28T12:02:48.071874-04:00"
@@ -2887,6 +2891,14 @@
28872891
"StatusCode": 206,
28882892
"LastSeen": "2025-01-16T13:05:48.070495-05:00"
28892893
},
2894+
"https://github.com/aws-observability/aws-otel-js": {
2895+
"StatusCode": 206,
2896+
"LastSeen": "2025-02-03T10:28:17.890526733Z"
2897+
},
2898+
"https://github.com/aws-observability/aws-otel-python": {
2899+
"StatusCode": 206,
2900+
"LastSeen": "2025-02-03T10:28:21.284075121Z"
2901+
},
28902902
"https://github.com/bacherfl": {
28912903
"StatusCode": 200,
28922904
"LastSeen": "2024-11-18T23:18:23.510566336Z"
@@ -6344,8 +6356,8 @@
63446356
"LastSeen": "2025-02-10T19:31:48.400126029Z"
63456357
},
63466358
"https://github.com/open-telemetry/opentelemetry-collector/blob/v0.119.0/component/config.go#L50": {
6347-
"StatusCode": 206,
6348-
"LastSeen": "2025-02-10T19:31:46.199745702Z"
6359+
"StatusCode": 200,
6360+
"LastSeen": "2025-02-11T11:40:12.345Z"
63496361
},
63506362
"https://github.com/open-telemetry/opentelemetry-collector/blob/v0.119.0/pdata/internal/data/protogen/trace/v1/trace.pb.go": {
63516363
"StatusCode": 206,
@@ -6360,8 +6372,8 @@
63606372
"LastSeen": "2025-02-10T19:31:58.756540779Z"
63616373
},
63626374
"https://github.com/open-telemetry/opentelemetry-collector/blob/v0.119.0/receiver/receiver.go#L58": {
6363-
"StatusCode": 206,
6364-
"LastSeen": "2025-02-10T19:31:53.421771005Z"
6375+
"StatusCode": 200,
6376+
"LastSeen": "2025-02-11T11:40:12.345Z"
63656377
},
63666378
"https://github.com/open-telemetry/opentelemetry-collector/blob/v0.119.0/semconv/v1.9.0/generated_resource.go": {
63676379
"StatusCode": 206,

0 commit comments

Comments
 (0)