Skip to content

Commit

Permalink
Fix markdown link check (#2350)
Browse files Browse the repository at this point in the history 
* Fix markdown link check

* Fix broken link

* Fix broken link

* another

* more
  • Loading branch information
@trask
trask authored Sep 18, 2024
1 parent c1d2a61 commit 2119c81
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/donation.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
attributes:
value: |
Welcome to the OpenTelemetry project! 👋🎉
Please review the [Donation Guidelines](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md#donations) before submitting this form.
Please review the [Donation Guidelines](https://github.com/open-telemetry/community/blob/main/guides/contributor/donations.md) before submitting this form.
- type: textarea
id: description
attributes:
Expand Down
3 changes: 3 additions & 0 deletions .github/scripts/markdown-link-check-config.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@
},
{
"pattern" : "https://civs1.civs.us/"
},
{
"pattern" : "https://slack.cncf.io/"
}
]
}
2 changes: 1 addition & 1 deletion Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ markdown-link-check:
@if ! npm ls markdown-link-check; then npm install; fi
find . -type f \
-name '*.md' \
-not -path './node_modules/*'
-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
Expand Down
6 changes: 2 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Table of Contents
* [Governing Bodies](#governing-bodies)
* [Areas of Interest](#areas-of-interest)
* [Communication](#communication)
* [Discussions](#discussions)
* [Slack](#slack)
* [Calendar](#calendar)
* [Mailing Lists](#mailing-lists)
* [Media](#media)
Expand Down Expand Up @@ -54,9 +54,7 @@ interested parties and form new special interest groups.

## Communication

### Discussions

We use [GitHub discussions](https://github.com/open-telemetry/community/discussions) for most communications. Please join us there!
### Slack

For those who are brand new to OpenTelemetry and want to chat or get redirected to the appropriate place for a specific question, feel free to join [the CNCF OpenTelemetry Slack channel](https://cloud-native.slack.com/archives/CJFCJHG4Q). If you are new, you can create a CNCF Slack account [here](https://slack.cncf.io/).

Expand Down
2 changes: 1 addition & 1 deletion governance-charter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ clear goals and are staffed sufficiently to deliver on an agreed upon deadline.
The Governance Committee is also responsible for deciding if a project is out of
scope for the OpenTelemetry project.

For proposals that involve [donating](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md#donations)
For proposals that involve [donating](https://github.com/open-telemetry/community/blob/main/guides/contributor/donations.md)
code bases to OpenTelemetry, the Governance Committee is responsible for
performing due diligence in determining if the donation is a strategic
fit for OpenTelemetry before referring the donation to the TC for
Expand Down
30 changes: 15 additions & 15 deletions guides/contributor/membership.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ maintainer!

## Membership Levels

| **Role** | **Responsibilities** | **Requirements** | **Defined by** |
|-----------------------|-------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
| member | active contributor in the community. reviewer of PRs | sponsored by 2 approvers or maintainers. multiple contributions to the project. | OpenTelemetry GitHub org member. |
| triager | assist with project management and backlog organization. | nominated by a maintainer. help with issues for one month. | CONTRIBUTING, CODEOWNERS, or the README. |
| approver | approve incoming contributions | highly experienced and active reviewer + contributor to a subproject | [CODEOWNERS](https://help.github.com/en/articles/about-code-owners) in GitHub |
| maintainer | set direction and priorities for a subproject | demonstrated responsibility and excellent technical judgement for the subproject | [CODEOWNERS](https://help.github.com/en/articles/about-code-owners), GitHub Team and repo ownership in GitHub |
| emeritus | position of honor for former maintainers, approvers, and triagers | must have previously held a community role and not have been removed from that role for a [Code of Conduct](code-of-conduct.md) violation. | Listed as an emeritus maintainer/approver/triager in CONTRIBUTING, CODEOWNERS, or README |
| specification sponsor | trusted collaborators for the specification | nominated by [Technical Committee][] | Listed in [Community Members -> Specification and Protos](./community-members.md#specifications-and-proto) |
| **Role** | **Responsibilities** | **Requirements** | **Defined by** |
|-----------------------|-------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| member | active contributor in the community. reviewer of PRs | sponsored by 2 approvers or maintainers. multiple contributions to the project. | OpenTelemetry GitHub org member. |
| triager | assist with project management and backlog organization. | nominated by a maintainer. help with issues for one month. | CONTRIBUTING, CODEOWNERS, or the README. |
| approver | approve incoming contributions | highly experienced and active reviewer + contributor to a subproject | [CODEOWNERS](https://help.github.com/en/articles/about-code-owners) in GitHub |
| maintainer | set direction and priorities for a subproject | demonstrated responsibility and excellent technical judgement for the subproject | [CODEOWNERS](https://help.github.com/en/articles/about-code-owners), GitHub Team and repo ownership in GitHub |
| emeritus | position of honor for former maintainers, approvers, and triagers | must have previously held a community role and not have been removed from that role for a [Code of Conduct](../../code-of-conduct.md) violation. | Listed as an emeritus maintainer/approver/triager in CONTRIBUTING, CODEOWNERS, or README |
| specification sponsor | trusted collaborators for the specification | nominated by [Technical Committee][] | Listed in [Community Members -> Specification and Protos](../../community-members.md#specifications-and-proto) |

## New contributors

Expand Down Expand Up @@ -58,7 +58,7 @@ Defined by: Member of the OpenTelemetry GitHub organization
- [Joined the Slack channel](https://cloud-native.slack.com/archives/CJFCJHG4Q)
- [Get an invite to join CNCF](https://slack.cncf.io/)
- Have read the [contributor
guide](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md)
guide](https://github.com/open-telemetry/community/blob/main/guides/contributor)
- Actively contributing to 1 or more subprojects.
- Sponsored by 2 approvers. Note the following requirements for sponsors:
- Sponsors must have close interactions with the prospective member - e.g.
Expand Down Expand Up @@ -206,7 +206,7 @@ The following apply to the subproject for which one would be a maintainer.
defined by Technical Committee (TC). Bringing general questions and requests
to the discussions as part of specifications project.
- Scheduling SIG meetings using the [OpenTelemetry Public
Calendar](./docs/how-to-handle-public-calendar.md).
Calendar](../../docs/how-to-handle-public-calendar.md).

### Responsibilities and privileges

Expand Down Expand Up @@ -277,10 +277,10 @@ work to review, approve, and sponsor [opentelemetry-specification][] issues and
PRs.

Members are defined
in [Community Members -> Specification and Protos](./community-members.md#specifications-and-proto)
in [Community Members -> Specification and Protos](../../community-members.md#specifications-and-proto)
and are members of the `spec-sponsors` team (TODO: add link to github team when
available). Specification sponsors SHOULD list
their [areas of interest](./areas-of-interest.md).
their [areas of interest](../../areas-of-interest.md).

### Requirements

Expand Down Expand Up @@ -337,7 +337,7 @@ are met:
The nominee is considered a specification sponsor after the pull request is
merged. The merger should update the `spec-sponsors` team with the new member.

[Governance Committee]: ./governance-charter.md
[Technical Committee]: ./tech-committee-charter.md
[Governance Committee]: ../../governance-charter.md
[Technical Committee]: ../../tech-committee-charter.md
[opentelemetry-specification]: https://github.com/open-telemetry/opentelemetry-specification
[Members of Standing]: ./governance-charter.md#members-of-standing
[Members of Standing]: ../../governance-charter.md#members-of-standing
2 changes: 1 addition & 1 deletion projects/ci-cd.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The following is a list of prototypes, plugins, components, and CI/CD related to
| Related Vendor | Prototype | Related Resources | Comments |
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| GitHub | [GitHub Actions Receiver](https://github.com/krzko/opentelemetry-collector-contrib/tree/feat-add-githubactionseventreceiver/receiver/githubactionsreceiver) | [OTEL Issue 27460](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/27460) | * Event logs to traces |
| GitHub/GitLab | [Git Provider Receiver](https://github.com/liatrio/liatrio-otel-collector/tree/main/receiver/gitproviderreceiver) | [OTEL Issue 22028](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/22028) | * Delivery metrics by scraping Git vendors |
| GitHub/GitLab | [GitHub Receiver](https://github.com/liatrio/liatrio-otel-collector/tree/main/receiver/githubreceiver)/[GitLab Receiver](https://github.com/liatrio/liatrio-otel-collector/tree/main/receiver/gitlabreceiver) | [OTEL Issue 22028](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/22028) | * Delivery metrics by scraping Git vendors |
| K8S | [Keptn](https://lifecycle.keptn.sh/) | [Keptn GitHub Repo](https://github.com/keptn/lifecycle-toolkit) | * Focused on observability in Kubernetes deployments |
| Jenkins | [OpenTelemetry plugin](https://plugins.jenkins.io/opentelemetry/) | [Plugin GitHub Repo](https://github.com/jenkinsci/opentelemetry-plugin) | * Tracing of Jenkins pipelines |
| Jenkins | [OpenTelemetry Agent Host Metrics](https://plugins.jenkins.io/opentelemetry-agent-metrics/) | | * Metrics for Jenkins hosts |
Expand Down

0 comments on commit 2119c81

Please sign in to comment.