Skip to content

Commit

Permalink
Change markdown link checker to lychee (open-telemetry#2503)
Browse files Browse the repository at this point in the history
* Change markdown link checker to lychee

* try

* Fix broken fragments

* cspell

* exclude

* perf

* all

* Fix broken link
  • Loading branch information
trask authored Jan 10, 2025
1 parent 160fe48 commit 814bea7
Show file tree
Hide file tree
Showing 16 changed files with 51 additions and 102 deletions.
1 change: 1 addition & 0 deletions .cspell.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ words:
- logz
- lucavallin
- lukas
- lycheeverse
- magnusbaeck
- maintainership
- mancuso
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/gc_member_onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The new member must:
2. [Concepts](https://opentelemetry.io/docs/concepts/)
3. [Specification](https://opentelemetry.io/docs/specs/otel/)
2. Have read and agreed to comply with the
[OpenTelemetry Governance Committee Charter](https://github.com/open-telemetry/community/blob/main/governance-charter.md)
[OpenTelemetry Governance Committee Charter](../../governance-charter.md)
as per requirements to stand for election.
3. Have an email address, Google account, and GitHub account and is willing
to share those details with other GC members.
Expand Down
51 changes: 0 additions & 51 deletions .github/scripts/markdown-link-check-config.json

This file was deleted.

17 changes: 0 additions & 17 deletions .github/scripts/markdown-link-check-with-retry.sh

This file was deleted.

16 changes: 16 additions & 0 deletions .lychee.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
include_fragments = true

accept = ["200..=299", "401", "403"]

exclude = [
"https://slack.com/help/articles/8328303095443-Understand-Channel-Managers-in-Slack",
"https://observe2020.io",
"https://servicenow.com",
# excluding links to user profiles is done for performance
# because there are a lot of links to user profiles in this repository
# and GitHub extra throttles access to user profile pages
"^https://github.com/[^/]+$"
]

# better to be safe and avoid failures
max_retries = 6
14 changes: 7 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ table-check:

.PHONY: markdown-link-check
markdown-link-check:
@if ! npm ls markdown-link-check; then npm install; fi
find . -type f \
-name '*.md' \
-not -path './node_modules/*' \
-not -path './elections/*/governance-committee-election.md' \
-not -path './elections/*/governance-committee-candidates.md' \
| xargs .github/scripts/markdown-link-check-with-retry.sh
docker run --rm \
--mount 'type=bind,source=$(PWD),target=/home/repo' \
lycheeverse/lychee \
--config home/repo/.lychee.toml \
--root-dir /home/repo \
--verbose \
home/repo

# This target runs markdown-toc on all files that contain
# a pair of comments <!-- toc --> and <!-- tocstop -->.
Expand Down
2 changes: 1 addition & 1 deletion community-members.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Governance Committee

This is the current Governance Committee, per the [Governance Committee
Charter](https://github.com/open-telemetry/community/blob/master/governance-charter.md),
Charter](./governance-charter.md),
in alphabetical order:

- [Alolita Sharma](https://github.com/alolita), Apple, until October 2026
Expand Down
2 changes: 1 addition & 1 deletion elections/2019/governance-committee-election.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,4 +219,4 @@ fill out the pre-registration form: https://forms.gle/9aqtXYm9BmZg7tjo9
- enzian
- cep21

[charter]:https://github.com/open-telemetry/community/blob/master/governance-charter.md#establishment-of-a-governance-committee
[charter]:../../governance-charter.md#elections
14 changes: 7 additions & 7 deletions elections/2020/governance-committee-election.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Please see **[the list of candidates running in the election here](./governance-

This document lays out the 2020 election process per the OpenTelemetry
governance committee
[charter document](https://github.com/open-telemetry/community/blob/master/governance-charter.md#establishment-of-a-governance-committee)
[charter document](../../governance-charter.md#elections)
requirements.

In this election there are four seats that need to be filled. The nominees list
Expand All @@ -17,7 +17,7 @@ community is well-represented by the Governance Committee.
# TL;DR

* If you‘ve been nominated or are willing to nominate yourself: check the
[charter document](https://github.com/open-telemetry/community/blob/master/governance-charter.md#establishment-of-a-governance-committee)
[charter document](../../governance-charter.md#elections)
and confirm you are ready for the commitment. Make sure to provide all
necessary information before 12:01am GMT on 2020/10/14
* If you are an active community member: confirm that you are in the voters
Expand Down Expand Up @@ -48,7 +48,7 @@ are welcome to run again for one of the four vacancies.

After this election and until October 2021, the Governance Committee will have
11 seats. Please refer to the
[charter document](https://github.com/open-telemetry/community/blob/master/governance-charter.md#establishment-of-a-governance-committee)
[charter document](../../governance-charter.md#elections)
for more information.


Expand All @@ -68,11 +68,11 @@ this process.
# Nominations

As per
[the charter document](https://github.com/open-telemetry/community/blob/master/governance-charter.md#establishment-of-a-governance-committee),
[the charter document](../../governance-charter.md#elections),
anybody is eligible to run for the Governance Committee. During the “call for
nomination” period, people can be nominated or nominate themselves by
submitting a Pull Request adding said candidate to the
[governance-committee-candidates.md](https://github.com/open-telemetry/community/blob/master/elections/2020/governance-committee-candidates.md)
[governance-committee-candidates.md](./governance-committee-candidates.md)
file in the OpenTelemetry community repository. The template in that file includes
the following columns:
* Full name
Expand Down Expand Up @@ -103,14 +103,14 @@ contributions, you need to pre-register so a voting link can be sent.

The form will ask for email and a proof of eligibility for the vote. Criteria
for voting eligibility are listed in the Members of Standing section of the
[charter document](https://github.com/open-telemetry/community/blob/master/governance-charter.md#members-of-standing).
[charter document](../../governance-charter.md#members-of-standing).

One of two options will be available in the form to prove eligibility:

* GitHub handle
* List either…
* Your contributions to OpenTelemetry that make you eligible to vote, or
* Your non-code contributions per the [Members of Standing section of the charter](https://github.com/open-telemetry/community/blob/master/governance-charter.md#members-of-standing):
* Your non-code contributions per the [Members of Standing section of the charter](../../governance-charter.md#members-of-standing):
particularly, your relationship to a well-known project that’s taken a hard
dependency on OpenTelemetry, and/or your involvement with a well-known
organization’s adoption of OpenTelemetry as an end-user.
Expand Down
12 changes: 6 additions & 6 deletions elections/2021/governance-committee-election.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Please see **[the list of candidates running in the election here](./governance-

This document lays out the 2021 election process per the OpenTelemetry
governance committee
[charter document](https://github.com/open-telemetry/community/blob/master/governance-charter.md#establishment-of-a-governance-committee)
[charter document](../../governance-charter.md#elections)
requirements.

In this election there are five seats that need to be filled.
Expand All @@ -24,7 +24,7 @@ community is well-represented by the Governance Committee.
# TL;DR

* If you‘ve been nominated or are willing to nominate yourself: check the
[charter document](https://github.com/open-telemetry/community/blob/master/governance-charter.md#establishment-of-a-governance-committee)
[charter document](../../governance-charter.md#elections)
and confirm you are ready for the commitment. Make sure to provide all
necessary information before 12:01am GMT on 2021/10/14
* If you are an active community member: confirm that you are in the voters
Expand Down Expand Up @@ -56,7 +56,7 @@ election cycle, though they are welcome to run again for one of the five vacanci

After this election and until October 2022, the Governance Committee will have
9 seats, all of which will be elected positions. Please refer to the
[charter document](https://github.com/open-telemetry/community/blob/master/governance-charter.md#establishment-of-a-governance-committee)
[charter document](../../governance-charter.md#elections)
for more information.


Expand All @@ -75,7 +75,7 @@ this process.
# Nominations

As per
[the charter document](https://github.com/open-telemetry/community/blob/master/governance-charter.md#establishment-of-a-governance-committee),
[the charter document](../../governance-charter.md#elections),
anybody is eligible to run for the Governance Committee. During the “call for
nomination” period, people can be nominated or nominate themselves by
submitting a Pull Request adding said candidate to the
Expand Down Expand Up @@ -103,7 +103,7 @@ directly to ensure the commitment and desire to be nominated.

# Voter Eligibility

All [members of standing](https://github.com/open-telemetry/community/blob/master/governance-charter.md#members-of-standing)
All [members of standing](../../governance-charter.md#members-of-standing)
will automatically be eligible to vote. To confirm your eligibility status,
see the [election announcements issue](https://github.com/open-telemetry/community/issues/852). If your code contributions do not meet
eligibility requirements, but you believe your non-code contributions
Expand All @@ -115,7 +115,7 @@ One of two options will be available in the form to prove eligibility:
* GitHub handle
* List either…
* Your contributions to OpenTelemetry that make you eligible to vote, or
* Your non-code contributions per the [Members of Standing section of the charter](https://github.com/open-telemetry/community/blob/master/governance-charter.md#members-of-standing):
* Your non-code contributions per the [Members of Standing section of the charter](../../governance-charter.md#members-of-standing):
particularly, your relationship to a well-known project that’s taken a hard
dependency on OpenTelemetry, and/or your involvement with a well-known
organization’s adoption of OpenTelemetry as an end-user.
Expand Down
6 changes: 3 additions & 3 deletions elections/2022/governance-committee-election.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Please see **[the list of candidates running in the election here](./governance-committee-candidates.md)**.

This document lays out the 2022 election process per the OpenTelemetry governance committee [charter document](https://github.com/open-telemetry/community/blob/main/governance-charter.md#establishment-of-a-governance-committee) requirements.
This document lays out the 2022 election process per the OpenTelemetry governance committee [charter document](../../governance-charter.md#elections) requirements.

This election should fill four seats.

Expand Down Expand Up @@ -38,7 +38,7 @@ Current governance committee members (alphabetical order):

Four people must be elected in this election, each with two-year terms. Note that four current Governance Committee members end terms as part of this election cycle, though they are welcome to run again for one of the four vacancies.

After this election and until October 2023, the Governance Committee will have nine seats, all of which will be elected positions. Please refer to the [charter document](https://github.com/open-telemetry/community/blob/main/governance-charter.md#establishment-of-a-governance-committee) for more information.
After this election and until October 2023, the Governance Committee will have nine seats, all of which will be elected positions. Please refer to the [charter document](../../governance-charter.md#elections) for more information.

# Voting process

Expand All @@ -52,7 +52,7 @@ The election committee should evaluate the following alternatives for the 2023 e

# Nominations

As per [the charter document](https://github.com/open-telemetry/community/blob/main/governance-charter.md#establishment-of-a-governance-committee), anybody is eligible to run for the Governance Committee. During the "call for nomination" period, people can be nominated or nominate themselves by submitting a Pull Request adding said candidate to the [governance-committee-candidates.md](https://github.com/open-telemetry/community/blob/main/elections/2022/governance-committee-candidates.md) file in the OpenTelemetry community repository. The template in that file includes the following columns:
As per [the charter document](../../governance-charter.md#elections), anybody is eligible to run for the Governance Committee. During the "call for nomination" period, people can be nominated or nominate themselves by submitting a Pull Request adding said candidate to the [governance-committee-candidates.md](https://github.com/open-telemetry/community/blob/main/elections/2022/governance-committee-candidates.md) file in the OpenTelemetry community repository. The template in that file includes the following columns:

* Full name
* GitHub alias
Expand Down
4 changes: 2 additions & 2 deletions elections/2023/governance-committee-election.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Please see **[the list of candidates running in the election here](./governance-committee-candidates.md)**.

This document lays out the 2023 election process per the OpenTelemetry governance committee [charter document](../../governance-charter.md#establishment-of-a-governance-committee) requirements.
This document lays out the 2023 election process per the OpenTelemetry governance committee [charter document](../../governance-charter.md#elections) requirements.

This election should fill five seats.

Expand Down Expand Up @@ -50,7 +50,7 @@ The governance committee also evaluated [Condorcet Internet Voting Service](http

# Nominations

As per [the charter document](../../governance-charter.md#establishment-of-a-governance-committee), anybody is eligible to run for the Governance Committee. During the "call for nomination" period, people can be nominated or nominate themselves by submitting a Pull Request adding said candidate to the [governance-committee-candidates.md](./governance-committee-candidates.md) file in the OpenTelemetry community repository. The template in that file includes the following columns:
As per [the charter document](../../governance-charter.md#elections), anybody is eligible to run for the Governance Committee. During the "call for nomination" period, people can be nominated or nominate themselves by submitting a Pull Request adding said candidate to the [governance-committee-candidates.md](./governance-committee-candidates.md) file in the OpenTelemetry community repository. The template in that file includes the following columns:

* Full name
* GitHub alias
Expand Down
4 changes: 2 additions & 2 deletions elections/2024/governance-committee-candidates.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ In alphabetical order:
- Company: [ServiceNow](https://servicenow.com)
- GitHub: [avillela](https://github.com/avillela)

I'm Adriana Villela, and I have been involved with OpenTelemetry since 2022. I am one of the maintainers of the OTel End User SIG, and I am also a CNCF Ambassador. I have been an early proponent of OpenTelemetry, since my days of working as a manager of the Observability Practices team at Tucows, where I convinced the entire organization of the importance of OpenTelemetry adoption before traces even went GA. I am a firm believer of this project and strive to contribute wherever I can - whether it's finding speakers for the End User SIG's [OTel in Practice](https://youtube.com/playlist?list=PLVYDBkQ1TdyxKgdGE4ThYLkNRCuLLYy9x&si=T6BMcqg09zik89OR) and [OTel Q&A](https://youtube.com/playlist?list=PLVYDBkQ1TdywIl9xKEo5_u7zlwY38dW43&si=aS53NEobEZ-f-HfK), collaborating with other SIGs to gather [user feedback](https://github.com/open-telemetry/sig-end-user/tree/main/end-user-surveysx), [documentation contributions](https://github.com/search?q=org%3Aopen-telemetry+avillela&type=pullrequests) (e.g. helping to make the OTel Operator more accessible), blog posts on the OTel blog, [my Medium blog](https://adri-v.medium.com/list/opentelemetry-92f897d8b31e), [my podcast])(https://youtube.com/@geekingout_pod), and [giving talks at conferences](https://youtube.com/playlist?list=PL2n5EpcOFZftDkMOL18RVKETHWTrvcKOD&si=mWd1-QNZWLIUoxFv) like KubeCon and Open Source Summit. I am committed to the OpenTelemetry project. One of my favourite aspects of the project is the community. Members are thoughtful, polite, and encouraging, providing a safe space to contribute, especially when it comes to feedback on things like pull requests, which is why I am always inspired to keep on contributing. I want to help keep that thoughtfulness and psychological safety alive.
I'm Adriana Villela, and I have been involved with OpenTelemetry since 2022. I am one of the maintainers of the OTel End User SIG, and I am also a CNCF Ambassador. I have been an early proponent of OpenTelemetry, since my days of working as a manager of the Observability Practices team at Tucows, where I convinced the entire organization of the importance of OpenTelemetry adoption before traces even went GA. I am a firm believer of this project and strive to contribute wherever I can - whether it's finding speakers for the End User SIG's [OTel in Practice](https://youtube.com/playlist?list=PLVYDBkQ1TdyxKgdGE4ThYLkNRCuLLYy9x&si=T6BMcqg09zik89OR) and [OTel Q&A](https://youtube.com/playlist?list=PLVYDBkQ1TdywIl9xKEo5_u7zlwY38dW43&si=aS53NEobEZ-f-HfK), collaborating with other SIGs to gather [user feedback](https://github.com/open-telemetry/sig-end-user/tree/main/end-user-surveys), [documentation contributions](https://github.com/search?q=org%3Aopen-telemetry+avillela&type=pullrequests) (e.g. helping to make the OTel Operator more accessible), blog posts on the OTel blog, [my Medium blog](https://adri-v.medium.com/list/opentelemetry-92f897d8b31e), [my podcast])(https://youtube.com/@geekingout_pod), and [giving talks at conferences](https://youtube.com/playlist?list=PL2n5EpcOFZftDkMOL18RVKETHWTrvcKOD&si=mWd1-QNZWLIUoxFv) like KubeCon and Open Source Summit. I am committed to the OpenTelemetry project. One of my favourite aspects of the project is the community. Members are thoughtful, polite, and encouraging, providing a safe space to contribute, especially when it comes to feedback on things like pull requests, which is why I am always inspired to keep on contributing. I want to help keep that thoughtfulness and psychological safety alive.

---

Expand Down Expand Up @@ -120,7 +120,7 @@ Thank you for your support!
Morgan is one of the co-founders of OpenTelemetry and W3C Trace Context, and he currently serves on the Governance Committee. He was instrumental in the creation of OpenTelemetry and assembling and focusing its earliest contributors, and his work continues to have a broad impact on the project:

- Oversaw the final drives towards the **beta and GA releases of both traces and metrics**
- **Proposed and co-led the [addition of logs as a new OpenTelemetry signal]([url](https://www.youtube.com/watch?v=a1KZwfLr2PQ&t=26s))**
- **Proposed and co-led the [addition of logs as a new OpenTelemetry signal](https://www.youtube.com/watch?v=a1KZwfLr2PQ&t=26s)**
- **Created the profiling SIG** to add profiles as a new OpenTelemetry signal, brought new members into the community to lead it, and managed the acceptance of the Elastic profiling agent to OpenTelemetry
- **Runs the weekly maintainers check-in** and contributes to various SIGs, including profiles and .Net
- **Created the OpenTelemetry Observatory** at Kubecon, which serves as a space for contributors to work together in person, and for new people to learn more about the project and get introduced to the community
Expand Down
Loading

0 comments on commit 814bea7

Please sign in to comment.