Skip to content

Commit 58e6847

Browse files
chalinchalin
authored
chore(cleanup): applies no-shortcut-ref-link --fix mdl rule to all en pages (#9248)
1 parent 368f811 commit 58e6847

43 files changed

Lines changed: 555 additions & 469 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.markdownlint.yaml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,11 @@ table-column-style: false # Causes problems in ja and zh pages
4141
# to provide configuration. Rules that need no config can be omitted.
4242

4343
no-shortcut-ref-link:
44-
false # TODO: re-enable when this PR lands with select file fixes
4544
# Skip:
4645
# - OTel spec informal footnotes like [1], [2]
4746
# - Markdown footnote references like [^1], [^note]
4847
# - Ellipsis like [...]
49-
# ignore_pattern: '^\d+(\.\.\d+)?$|^\.\.\.$' # skip [1], [2], [0..1], etc.
48+
ignore_pattern: '^\d+(\.\.\d+)?$|^\.\.\.$' # skip [1], [2], [0..1], etc.
5049

5150
# -----------------------------------------------------------------------------
5251
# Link-validation rules (from scripts/_md-rules/link-rules.mjs)

‎content/en/blog/2022/instrument-nginx/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ What this `Dockerfile` does:
4040

4141
- Pull a base image with NGINX 1.23.1 pre-installed
4242
- Install `unzip`
43-
- Download the [opentelemetry-webserver-sdk-x64-linux] package
43+
- Download the [opentelemetry-webserver-sdk-x64-linux][] package
4444
- Unpack the package, put it into `/opt` & run `./install.sh`
4545
- Add the dependencies at `/opt/opentelemetry-webserver-sdk/sdk_lib/lib` to the
4646
library path (`LD_LIBRARY_PATH`)
@@ -355,7 +355,7 @@ Within a few moments you should have five docker containers up and running:
355355
- Backend
356356

357357
Send a few requests to the frontend with `curl localhost:8000` and then check
358-
the Jaeger UI in your browser at [localhost:16686]. You should see traces going
358+
the Jaeger UI in your browser at [localhost:16686][]. You should see traces going
359359
from frontend to NGINX to backend.
360360

361361
The frontend trace should indicate an error, since NGINX is forwarding the

‎content/en/blog/2022/otel-demo-app-nomad/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ Before I wrap this up, I do want to give a HUGE shoutout to
350350
[Luiz Aoqui](https://www.linkedin.com/in/luizaoqui/) of HashiCorp, who helped me
351351
tweak my Nomad jobspecs, and to
352352
[Riaan Nolan](https://www.linkedin.com/in/riaannolan/), for his continued work
353-
on HashiQube. (Aside, both [Luiz] and [Riaan] were my guests on the [On-Call Me
353+
on HashiQube. (Aside, both [Luiz][] and [Riaan][] were my guests on the [On-Call Me
354354
Maybe Podcast]!)
355355

356356
I will now leave you with a picture of Phoebe the rat, peering out of a pink

‎content/en/blog/2023/integrations.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ date: 2023-11-06
66

77
{{< blog/integration-badge >}}
88

9-
Embracing OpenTelemetry's [vision], we are committed to enabling high-quality
9+
Embracing OpenTelemetry's [vision][], we are committed to enabling high-quality
1010
telemetry throughout the entire software stack!
1111

1212
We're thrilled to see an expanding collection of

‎content/en/blog/2024/go-opentelemetry-io.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ With contributions from Tyler Yahn and Austin Parker.
1212

1313
## TL;DR
1414

15-
The app that serves requests to [go.opentelemetry.io] will be migrating to a new
16-
host on September 5, 2024 at approximately 11:00AM Eastern Time. **There are no
17-
changes required from you**. We are making this announcement because it is
15+
The app that serves requests to [go.opentelemetry.io][] will be migrating to a
16+
new host on September 5, 2024 at approximately 11:00AM Eastern Time. **There are
17+
no changes required from you**. We are making this announcement because it is
1818
possible, but unlikely, that there might be downtime during this transition.
1919

2020
## Details
@@ -57,7 +57,7 @@ this.
5757

5858
## What you might notice
5959

60-
There is the possibility of the [go.opentelemetry.io] domain experiencing
60+
There is the possibility of the [go.opentelemetry.io][] domain experiencing
6161
downtime during this transition. If this happens, you might see projects that
6262
import `go.opentelemetry.io` modules failing to compile.
6363

‎content/en/blog/2024/kubecon-eu.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ that SIG. Sessions will be recorded and posted on the
133133
[OTel YouTube channel](https://youtube.com/@otel-official).
134134

135135
We will create action items from your comments as appropriate. Check
136-
[#otel-user-research] in CNCF's Slack instance for results and action item
136+
[#otel-user-research][] in CNCF's Slack instance for results and action item
137137
updates to come after KubeCon EU.
138138

139139
Back by popular demand! We'll be recording

‎content/en/blog/2024/kubecon-na.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ You can help us improve the project by sharing your thoughts and feedback about
119119
your OpenTelemetry adoption, implementation, and usage.
120120

121121
We will create action items from your comments as appropriate. Check
122-
[#otel-sig-end-user] in CNCF's Slack instance for results and action item
122+
[#otel-sig-end-user][] in CNCF's Slack instance for results and action item
123123
updates to come after KubeCon EU.
124124

125125
Come join us to listen, learn, and get involved in OpenTelemetry.

‎content/en/blog/2024/otel-docs-survey/index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,15 @@ results.
5555

5656
#### Q: What source do you primarily rely on when you're looking for information about OpenTelemetry?
5757

58-
- Overall, the majority of respondents (52%) rely on the [opentelemetry.io]
58+
- Overall, the majority of respondents (52%) rely on the [opentelemetry.io][]
5959
documentation.
6060
- Respondents early in their observability practice (beginner and intermediate)
61-
are more likely to use the [opentelemetry.io] documentation.
61+
are more likely to use the [opentelemetry.io][] documentation.
6262
- Expert observability practitioners prefer the code repository documentation.
6363

6464
[opentelemetry.io]: /docs/
6565

66-
> **Respondents who use [opentelemetry.io] as their primary information**
66+
> **Respondents who use [opentelemetry.io][] as their primary information**
6767
> source<br>_By level of observability knowledge_
6868
>
6969
> | Beginners | Intermediates | Experts |
@@ -75,7 +75,7 @@ results.
7575
#### Q: What features or information would you like to see added to opentelemetry.io that aren't currently available?
7676

7777
We asked respondents to describe in their own words what they'd like to see
78-
added to the [opentelemetry.io] documentation. We loosely grouped their
78+
added to the [opentelemetry.io][] documentation. We loosely grouped their
7979
responses into six categories. Some answers fell in more than one category. For
8080
full responses, see [Docs Usability Survey Responses].
8181

‎content/en/blog/2024/year-in-review.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Key IA updates include:
5555
[Zero-code Instrumentation](/docs/zero-code/) section to more clearly
5656
distinguish between instrumentation APIs & SDKs and tools like the Java agent,
5757
used to inject telemetry.
58-
- Following these updates, the Java SIG [proposed] and [reorganized their
58+
- Following these updates, the Java SIG [proposed][] and [reorganized their
5959
documentation][java-reorg], introducing substantial improvements to the
6060
structure and clarity of the content. The bulk of this effort is reflected in
6161
these PRs:
@@ -120,20 +120,20 @@ OpenTelemetry website. Your efforts make a difference!
120120

121121
### Which pages were the most popular?
122122

123-
According to our publicly available [analytics] data, [opentelemetry.io](/) was
124-
viewed **12 million** times across 4 million sessions this year. This marks a
125-
**16% increase** over last year's nearly 10 million views and over 3 million
123+
According to our publicly available [analytics][] data, [opentelemetry.io](/)
124+
was viewed **12 million** times across 4 million sessions this year. This marks
125+
a **16% increase** over last year's nearly 10 million views and over 3 million
126126
sessions.
127127

128128
The most popular pages and sections of the documentation were:
129129

130130
| Page/Section | Views | % [^1] |
131131
| ------------------------ | ----: | -----: |
132132
| [What is OpenTelemetry?] | 290K | 2.4% |
133-
| [Collector] | 1.3M | 10.5% |
134-
| [Concepts] | 1.2M | 9.8% |
135-
| [Demo] | 829K | 6.7% |
136-
| [Ecosystem] | 500K | 4.0% |
133+
| [Collector][] | 1.3M | 10.5% |
134+
| [Concepts][] | 1.2M | 9.8% |
135+
| [Demo][] | 829K | 6.7% |
136+
| [Ecosystem][] | 500K | 4.0% |
137137

138138
[analytics]: https://lookerstudio.google.com/s/tSTKxK1ECeU
139139
[Collector]: /docs/collector
@@ -153,8 +153,8 @@ Did you know that:
153153
times, putting it in 11th place!
154154
- The [Collector landing page] has been the most updated file since its
155155
creation, with 91 changes.
156-
- With 511 commits (27K additions, and 10K deletions) the [opentelemetrybot] is
157-
the fourth most active contributor. Go bots!
156+
- With 511 commits (27K additions, and 10K deletions) the [opentelemetrybot][]
157+
is the fourth most active contributor. Go bots!
158158
- The record for the PR with the most comments this year—and of all time is held
159159
by:
160160
- [Generative AI updates blog post (#5575)][#5575], with 150 comments!
@@ -176,7 +176,7 @@ reviews to ensure that content is accurate, valuable, aligned with our
176176
documentation goals, and easy to read and understand.
177177

178178
In addition to PRs, contributors created nearly [500 issues] and engaged in many
179-
[discussions], reporting bugs, suggesting improvements, and driving
179+
[discussions][], reporting bugs, suggesting improvements, and driving
180180
collaboration. Each of these efforts reflects our community's dedication to
181181
maintaining the quality of OpenTelemetry docs.
182182

@@ -205,7 +205,7 @@ to continuing our collaboration in 2025.
205205

206206
Whether you're an end user, a contributor, or simply enthusiastic about
207207
OpenTelemetry, we welcome your participation. You can [get involved] by raising
208-
[issues], participating in [discussions], or [submitting PRs].
208+
[issues][], participating in [discussions][], or [submitting PRs].
209209

210210
You can also join us:
211211

‎content/en/blog/2025/kubecon-eu.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ cSpell:ignore: Adevinta Aftab Arianna Baeyens Bartłomiej Boulineau Celalettin C
1111

1212
The OpenTelemetry governance and technical committees, along with the project's
1313
maintainers, invite you to join them and other members of the OpenTelemetry
14-
community at [KubeCon + CloudNativeCon Europe][] ([registration]) and at the
14+
community at [KubeCon + CloudNativeCon Europe][] ([registration][]) and at the
1515
co-located [Observability Day] in London from April 1 to 4, 2025.
1616

1717
This post covers all currently scheduled activities related to OpenTelemetry
@@ -159,7 +159,7 @@ well.
159159
## OpenTelemetry Observatory Booth {#opentelemetry-observatory}
160160

161161
Drop by and say _"Hi!"_ at **OpenTelemetry Observatory booth** in the Expo
162-
Hall[^1], courtesy of [Splunk]. This will be a place for informal chats,
162+
Hall[^1], courtesy of [Splunk][]. This will be a place for informal chats,
163163
meetups, and other discussions led by OpenTelemetry community members and
164164
maintainers.
165165

@@ -174,7 +174,7 @@ like to participate or lead a discussion or short presentation, reach out to the
174174
You can also help us improve OTel by sharing your thoughts and feedback about
175175
your OpenTelemetry adoption, implementation, and usage experiences. We will
176176
create action items from your comments as appropriate, and post results to
177-
[#otel-sig-end-user] after the conference.
177+
[#otel-sig-end-user][] after the conference.
178178

179179
{{< comment >}}
180180

0 commit comments

Comments
 (0)