Skip to content

Commit

Permalink
Merge branch 'main' into mx-psi/preserve-internal-repr
Browse files Browse the repository at this point in the history
  • Loading branch information
codeboten authored Aug 16, 2024
2 parents ef00042 + dec435a commit 92951ab
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 6 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ jobs:
- name: Render .chloggen changelog entries
run: make chlog-preview > changelog_preview.md
- name: Install markdown-link-check
run: npm install -g markdown-link-check
run: npm install
- name: Run markdown-link-check
run: |
markdown-link-check \
npx --no -- markdown-link-check \
--verbose \
--config .github/workflows/check_links_config.json \
changelog_preview.md \
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/check-links.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: check-links
on:
push:
branches: [ main ]
branches: [main]
pull_request:

concurrency:
Expand Down Expand Up @@ -39,11 +39,11 @@ jobs:
fetch-depth: 0

- name: Install markdown-link-check
run: npm install -g [email protected]
run: npm install

- name: Run markdown-link-check
run: |
markdown-link-check \
npx --no -- markdown-link-check \
--verbose \
--config .github/workflows/check_links_config.json \
${{needs.changedfiles.outputs.md}} \
Expand Down
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,8 @@ benchmarks.txt

# golang
go.work*

# npm (used for markdown-link-check)
node_modules/*
package-lock.json

10 changes: 10 additions & 0 deletions cmd/mdatagen/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Metadata Generator

<!-- status autogenerated section -->
| Status | |
| ------------- |-----------|
| Stability | [alpha]: metrics |
| Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Acmd%2Fmdatagen%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Acmd%2Fmdatagen) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Acmd%2Fmdatagen%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Acmd%2Fmdatagen) |
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@dmitryax](https://www.github.com/dmitryax) |

[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
<!-- end autogenerated section -->

Every component's documentation should include a brief description of the component and guidance on how to use it.
There is also some information about the component (or metadata) that should be included to help end-users understand the current state of the component and whether it is right for their use case.
Examples of this metadata about a component are:
Expand Down
2 changes: 1 addition & 1 deletion connector/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Connectors

A connector is both an exporter and receiver. As the name suggests a Connector connects
two pipelines: it consumes data as an exporter at the end of one pipeline and emits data
two pipelines: it emits data as an exporter at the end of one pipeline and consumes data
as a receiver at the start of another pipeline. It may consume and emit data of the same data
type, or of different data types. A connector may generate and emit data to summarize the
consumed data, or it may simply replicate or route data.
Expand Down
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"devDependencies": {
"markdown-link-check": "^3.11.2"
}
}

0 comments on commit 92951ab

Please sign in to comment.