Skip to content

Commit

Permalink
Merge branch 'main' into dotnet-process-metrics
Browse files Browse the repository at this point in the history
  • Loading branch information
Kielek authored Nov 30, 2023
2 parents 10b1214 + 4318288 commit da6f249
Show file tree
Hide file tree
Showing 57 changed files with 2,189 additions and 521 deletions.
11 changes: 6 additions & 5 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@
* @open-telemetry/docs-approvers

# content owners
content-modules/opamp-spec @open-telemetry/docs-approvers @open-telemetry/opamp-spec-approvers
content-modules/opentelemetry-proto @open-telemetry/docs-approvers @open-telemetry/specs-approvers
content-modules/opentelemetry-specification @open-telemetry/docs-approvers @open-telemetry/specs-approvers
content-modules/semantic-conventions @open-telemetry/docs-approvers @open-telemetry/specs-semconv-approvers
content/en/blog/ @open-telemetry/docs-approvers @open-telemetry/blog-approvers
content-modules/ @open-telemetry/docs-maintainers
content-modules/opamp-spec @open-telemetry/docs-maintainers @open-telemetry/opamp-spec-approvers
content-modules/opentelemetry-proto @open-telemetry/docs-maintainers @open-telemetry/specs-approvers
content-modules/opentelemetry-specification @open-telemetry/docs-maintainers @open-telemetry/specs-approvers
content-modules/semantic-conventions @open-telemetry/docs-maintainers @open-telemetry/specs-semconv-approvers
content/en/blog/ @open-telemetry/docs-maintainers
content/en/community/end-user/ @open-telemetry/docs-approvers @open-telemetry/end-user-wg
content/en/docs/collector @open-telemetry/docs-approvers @open-telemetry/collector-approvers
content/en/docs/demo @open-telemetry/docs-approvers @open-telemetry/demo-approvers
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/auto-update-versions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Use CLA approved github bot
run: |
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/check-format.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ jobs:
name: FILENAME check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- run: npm run check:filenames

check-formatting:
name: FILE FORMAT
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Create NPM cache-hash input file
run: |
mkdir -p tmp
jq '{devDependencies, dependencies, engines, gitHubActionCacheKey}' package.json > tmp/package-ci.json
- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
name: BUILD and CHECK LINKS
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Create NPM cache-hash input file
run: |
Expand All @@ -24,7 +24,7 @@ jobs:
package.json > tmp/package-min.json
cp tmp/package-min.json package.json
- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
Expand All @@ -46,7 +46,7 @@ jobs:
needs: build-and-check-links
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: actions/download-artifact@v3
with: { name: build-log-etc }
- run: npm run diff:fail
Expand All @@ -56,7 +56,7 @@ jobs:
needs: build-and-check-links
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: actions/download-artifact@v3
with: { name: build-log-etc }
- run: cat tmp/build-log.txt
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/check-spelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
name: SPELLING check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: streetsidesoftware/cspell-action@v2
with:
# Files should be consistent with check:spelling files
Expand All @@ -22,7 +22,7 @@ jobs:
name: CSPELL:IGNORE check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- run: npm run fix:dict
- name: Any changed files?
run: |
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/check-text.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
name: TEXT linter
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
# Make sure that we only install the dependencies for textlint to speed up install
- run: |
mkdir -p tmp
Expand All @@ -23,7 +23,7 @@ jobs:
name: MARKDOWN linter
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Create and use reduced-dependencies package.json
run: |
Expand Down
59 changes: 50 additions & 9 deletions .github/workflows/pr-actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,23 @@ jobs:
contains(github.event.comment.body, '/fix:format')
permissions:
contents: write
pull-requests: write

steps:
- name: Context info
run: |
echo $PR_NUM
echo $COMMENT
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- run: gh pr checkout $PR_NUM
- name: Write start comment
run: |
gh pr comment $PR_NUM -b "You triggered fix:format action run at $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"
env:
GH_TOKEN: ${{ github.token }}

- run: gh pr checkout $PR_NUM -b "pr-action-${RANDOM}"
env:
GH_TOKEN: ${{ github.token }}

Expand All @@ -38,7 +45,7 @@ jobs:
mkdir -p tmp
jq '{devDependencies, dependencies, engines, gitHubActionCacheKey}' package.json > tmp/package-ci.json
- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
Expand All @@ -57,14 +64,27 @@ jobs:
git add -A
current_branch=$(git rev-parse --abbrev-ref HEAD)
echo current_branch=$current_branch
# gh pr checkout sets some git configs that we can use to make sure
# we push to the right repo & to the right branch
remote_repo=$(git config --get branch.${current_branch}.remote)
echo remote_repo=$remote_repo
remote_branch=$(git config --get branch.${current_branch}.merge)
echo remote_branch=$remote_branch
git commit -m 'Results from /fix:format'
git push origin $current_branch
git push ${remote_repo} HEAD:${remote_branch}
else
echo "No changes to commit"
fi
env:
GH_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}

- name: Report an error in the case of failure
if: ${{ failure() || cancelled() }}
run: |
gh pr comment $PR_NUM -b "fix:format run failed, please check $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID for details"
env:
GH_TOKEN: ${{ github.token }}

fix-refcache:
name: /fix:refcache
runs-on: ubuntu-latest
Expand All @@ -84,9 +104,17 @@ jobs:
echo $PR_NUM
echo $COMMENT
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- run: gh pr checkout $PR_NUM
- name: Write start comment
run: |
gh pr comment $PR_NUM -b "You triggered fix:refcache action run at $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"
env:
GH_TOKEN: ${{ github.token }}

# By providing a branch name the checkout will not break if a branch with the
# same name exists already upstream (e.g. patch-X)
- run: gh pr checkout $PR_NUM -b "pr-action-${RANDOM}"
env:
GH_TOKEN: ${{ github.token }}

Expand All @@ -95,7 +123,7 @@ jobs:
mkdir -p tmp
jq '{devDependencies, dependencies, engines, gitHubActionCacheKey}' package.json > tmp/package-ci.json
- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
Expand All @@ -115,10 +143,23 @@ jobs:
git add -A
current_branch=$(git rev-parse --abbrev-ref HEAD)
echo current_branch=$current_branch
git commit -m 'Results from /fix:recache'
git push origin $current_branch
# gh pr checkout sets some git configs that we can use to make sure
# we push to the right repo & to the right branch
remote_repo=$(git config --get branch.${current_branch}.remote)
echo remote_repo=$remote_repo
remote_branch=$(git config --get branch.${current_branch}.merge)
echo remote_branch=$remote_branch
git commit -m 'Results from /fix:refcache'
git push ${remote_repo} HEAD:${remote_branch}
else
echo "No changes to commit"
fi
env:
GH_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}

- name: Report an error in the case of failure
if: ${{ failure() || cancelled() }}
run: |
gh pr comment $PR_NUM -b "fix:recache run failed, please check $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID for details"
env:
GH_TOKEN: ${{ github.token }}
19 changes: 8 additions & 11 deletions .htmltest.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
CacheExpires: 4400h # ~ 6 months
CacheExpires: 6000h # ~ 8.2 months
DirectoryPath: public
IgnoreDirectoryMissingTrailingSlash: true
IgnoreAltMissing: true
IgnoreCanonicalBrokenLinks: false
CheckMailto: false
IgnoreDirs:
- ^blog/(\d+/)?page/\d+
IgnoreInternalURLs: # list of paths
IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^/docs/instrumentation/\w+/(api|examples)/$
Expand All @@ -18,6 +20,9 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^https?://127\.0\.0\.1\b
- ^https?://(otel-demo|traefik)\.localhost

# OpAMP spec:
- ^https://pdf.sciencedirectassets.com/280203/1-s2.0-S1877050919X0006X/1-s2.0-S1877050919303576/main.pdf\?

# Sites that deny access, always yielding 403 Forbidden (unless mentioned otherwise)
- ^https://(www\.)?linkedin\.com\b # 999 Request Denied
- ^https://(www\.)?mvnrepository\.com
Expand All @@ -41,13 +46,5 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^https://crates\.io/crates
# TODO: drop after fix to https://github.com/micrometer-metrics/micrometer-docs/issues/239
- ^https://micrometer\.io/docs
# TODO: drop after fix to https://github.com/google/docsy/issues/1337
- ^https://opentelemetry\.io/.
# TODO: drop after fix to https://github.com/open-telemetry/opentelemetry.io/issues/2354
- ^https://open-telemetry\.github\.io/opentelemetry-python/benchmarks/
# TODO: remove after merge of https://github.com/open-telemetry/opentelemetry.io/pull/2594
- ^https://elastic.co/blog/ecs-elastic-common-schema-otel-opentelemetry-announcement
# TODO: remove after OpAMP spec is fixed: https://github.com/open-telemetry/opamp-spec/issues/148
- ^https://example.com:4318/v1/metrics
- ^https://pdf.sciencedirectassets.com/280203/1-s2.0-S1877050919X0006X
- ^https://research.fb.com/wp-content/uploads/2016/11/holistic-configuration-management-at-facebook.pdf
# TODO: ensure .json isn't set as an alternate in ecosystem/registry/index.html and then drop:
- ^https://opentelemetry.io/ecosystem/registry/index.json
6 changes: 5 additions & 1 deletion .textlintrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ filters:
# Hugo template syntax:
- /{{.*?}}/
- /{{%.*?%}}/
# Other
# Custom header anchors in markdown headings:
- /{#.*?}/
# src attribute in figure Hugo template:
- /src=".*?"/
# Other:
- /<https?://.*?>/ # Raw URLs
rules:
terminology:
Expand Down
15 changes: 12 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,16 @@ For small changes to a single file, you can edit directly in GitHub by clicking
**Edit this file** button. After forking the repository, follow the instructions
in [Editing files][].

For everything else, follow the
However, formatting may still be needed, like reducing line lengths in the
edited file. The options for fixing formatting are:

- Checking out the project and running the CLI scripts mentioned in
[Submitting a change](#submitting-a-change).
- Commenting `/fix:format` on your pull request to trigger an automated script.
This requires a unique branch name, which can be edited under _View all
branches_ in your fork.

For larger fixes, follow the
[instructions to setup a development environment](#development) below.

### PR Guidelines
Expand Down Expand Up @@ -212,8 +221,8 @@ The website is built from the following content:

### Submitting a change

Before submitting a to the repository, run the following command and address any
reported issues. Also commit any files changed by the `fix` script:
Before submitting a change to the repository, run the following command and
address any reported issues. Also commit any files changed by the `fix` script:

```sh
npm run test-and-fix
Expand Down
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,29 @@ schedule.
Meeting notes are available as a public [Google doc][]. If you have trouble
accessing the doc, please get in touch on [Slack][].

Roles:
Here is a list of community roles with current and previous members:

- Approvers: [@open-telemetry/docs-approvers][]

- [Fabrizio Ferri-Benedetti](https://github.com/theletterf), Splunk
- [Michael Hausenblas](https://github.com/mhausenblas), Amazon

- Maintainers: [@open-telemetry/docs-maintainers][]
- Blog approvers: [@open-telemetry/blog-approvers][]

- [Austin Parker](https://github.com/austinlparker), Honeycomb
- [Patrice Chalin](https://github.com/chalin), CNCF
- [Phillip Carter](https://github.com/cartermp), Honeycomb
- [Severin Neumann](https://github.com/svrnm), Cisco

- Emeritus approvers:

- [Paul Bruce](https://github.com/paulsbruce)

- Emeritus maintainers:

- [Steve Flanders](https://github.com/flands)
- [Morgan McLean](https://github.com/mtwo)
- [jparsana](https://github.com/jparsana)

Learn more about roles in the [community repository][]. Thanks to [all who have
already contributed][contributors]!
Expand All @@ -91,8 +109,6 @@ already contributed][contributors]!
[adding to the registry]: https://opentelemetry.io/ecosystem/registry/adding/
[let us know]:
https://github.com/open-telemetry/opentelemetry.io/issues/new/choose
[@open-telemetry/blog-approvers]:
https://github.com/orgs/open-telemetry/teams/blog-approvers
[@open-telemetry/docs-approvers]:
https://github.com/orgs/open-telemetry/teams/docs-approvers
[@open-telemetry/docs-maintainers]:
Expand Down
6 changes: 5 additions & 1 deletion archetypes/blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ With contributions from secondary-author-name-1, ..., and secondary-author-n.

## Top-level heading

Top-level headings start at **level 2**, as shown above.
Top-level headings start at **level 2**. This means, that your post should not
include `# headings` for top-level headings but `## headings` instead.

## Paragraphs

Expand All @@ -44,3 +45,6 @@ npm run format
```

Happy writing!

**Note:** If you view this page with the GitHub file viewer, you can safely
ignore the `Error in user YAML` at the top of this page.
8 changes: 0 additions & 8 deletions assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -275,14 +275,6 @@ body.td-page--draft .td-content {
}
}

// TODO(@chalin): upstream
.tab-body {
> .highlight:only-child {
margin: -1.5rem;
max-width: calc(100% + 3rem);
}
}

details {
margin-bottom: $paragraph-margin-bottom;
}
Expand Down
2 changes: 1 addition & 1 deletion content-modules/opamp-spec
Loading

0 comments on commit da6f249

Please sign in to comment.