Skip to content

Commit

Permalink
Merge branch 'main' into pr-4124
Browse files Browse the repository at this point in the history
  • Loading branch information
svrnm committed Jun 11, 2024
2 parents 98fc542 + e89a198 commit 36804bb
Show file tree
Hide file tree
Showing 633 changed files with 11,564 additions and 3,028 deletions.
4 changes: 3 additions & 1 deletion .cspell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ version: '0.2'
caseSensitive: true
ignorePaths:
- '*.svg'
- 'vendors.yaml'
# words here are only listed for their spelling, if there is a certain way
# to write a word (e.g. OpenTelemetry vs Opentelemetry or cloud native vs
# cloud-native), edit the text-lint rules in .textlintrc.yml
Expand Down Expand Up @@ -40,7 +41,6 @@ words:
- autoloader
- autoloading
- backoff
- bytecode
- caml
- cartservice
- cassandra
Expand Down Expand Up @@ -113,6 +113,7 @@ words:
- overridable
- outro
- packagist
- pageinfo
- Paixão
- parentbased
- Pavol
Expand Down Expand Up @@ -170,3 +171,4 @@ words:
- WSGI
- zend
- zipkin
- Chronosphere
34 changes: 19 additions & 15 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,27 @@ content-modules/opentelemetry-proto @open-telemetry/docs-maintainers @open-
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/community/end-user/ @open-telemetry/docs-approvers @open-telemetry/sig-end-user-approvers
content/en/docs/collector @open-telemetry/docs-approvers @open-telemetry/collector-approvers
content/en/docs/contributing/ @open-telemetry/docs-approvers @open-telemetry/docs-maintainers
content/en/docs/demo @open-telemetry/docs-approvers @open-telemetry/demo-approvers
content/en/docs/languages/cpp/ @open-telemetry/docs-approvers @open-telemetry/cpp-approvers
content/en/docs/languages/erlang/ @open-telemetry/docs-approvers @open-telemetry/erlang-approvers
content/en/docs/languages/go/ @open-telemetry/docs-approvers @open-telemetry/go-approvers @open-telemetry/go-instrumentation-approvers
content/en/docs/languages/java/ @open-telemetry/docs-approvers @open-telemetry/java-approvers @open-telemetry/java-instrumentation-approvers
content/en/docs/languages/js/ @open-telemetry/docs-approvers @open-telemetry/javascript-approvers
content/en/docs/languages/net/ @open-telemetry/docs-approvers @open-telemetry/dotnet-approvers @open-telemetry/dotnet-instrumentation-approvers
content/en/docs/languages/php/ @open-telemetry/docs-approvers @open-telemetry/php-approvers
content/en/docs/languages/python/ @open-telemetry/docs-approvers @open-telemetry/python-approvers
content/en/docs/languages/ruby/ @open-telemetry/docs-approvers @open-telemetry/ruby-approvers @open-telemetry/ruby-contrib-approvers
content/en/docs/languages/rust/ @open-telemetry/docs-approvers @open-telemetry/rust-approvers
content/en/docs/languages/swift/ @open-telemetry/docs-approvers @open-telemetry/swift-approvers
content/en/docs/kubernetes/operator/ @open-telemetry/docs-approvers @open-telemetry/operator-approvers
content/en/docs/kubernetes/helm/ @open-telemetry/docs-approvers @open-telemetry/helm-approvers
content/en/docs/specs/ @open-telemetry/docs-approvers @open-telemetry/specs-approvers
content/en/docs/kubernetes/operator/ @open-telemetry/docs-approvers @open-telemetry/operator-approvers
content/en/docs/languages/cpp/ @open-telemetry/docs-approvers @open-telemetry/cpp-approvers
content/en/docs/languages/erlang/ @open-telemetry/docs-approvers @open-telemetry/erlang-approvers
content/en/docs/languages/go/ @open-telemetry/docs-approvers @open-telemetry/go-approvers @open-telemetry/go-instrumentation-approvers
content/en/docs/languages/java/ @open-telemetry/docs-approvers @open-telemetry/java-approvers @open-telemetry/java-instrumentation-approvers
content/en/docs/languages/js/ @open-telemetry/docs-approvers @open-telemetry/javascript-approvers
content/en/docs/languages/net/ @open-telemetry/docs-approvers @open-telemetry/dotnet-approvers @open-telemetry/dotnet-instrumentation-approvers
content/en/docs/languages/php/ @open-telemetry/docs-approvers @open-telemetry/php-approvers
content/en/docs/languages/python/ @open-telemetry/docs-approvers @open-telemetry/python-approvers
content/en/docs/languages/ruby/ @open-telemetry/docs-approvers @open-telemetry/ruby-approvers @open-telemetry/ruby-contrib-approvers
content/en/docs/languages/rust/ @open-telemetry/docs-approvers @open-telemetry/rust-approvers
content/en/docs/languages/swift/ @open-telemetry/docs-approvers @open-telemetry/swift-approvers
content/en/docs/security/ @open-telemetry/docs-approvers @open-telemetry/sig-security-maintainers
content/en/docs/specs/ @open-telemetry/docs-approvers @open-telemetry/specs-approvers
content/en/docs/zero-code/java/ @open-telemetry/docs-approvers @open-telemetry/java-approvers @open-telemetry/java-instrumentation-approvers
content/en/docs/zero-code/js/ @open-telemetry/docs-approvers @open-telemetry/javascript-approvers
content/en/docs/zero-code/net/ @open-telemetry/docs-approvers @open-telemetry/dotnet-approvers @open-telemetry/dotnet-instrumentation-approvers
content/en/ecosystem/demo/ @open-telemetry/demo-approvers @open-telemetry/demo-approvers
content/en/docs/contributing/ @open-telemetry/docs-approvers @open-telemetry/docs-maintainers
content/zh/ @open-telemetry/docs-maintainers @open-telemetry/docs-zh-approvers
93 changes: 93 additions & 0 deletions .github/component-label-map.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
blog:
- changed-files:
- any-glob-to-any-file:
- content/en/blog/**
registry:
- changed-files:
- any-glob-to-any-file:
- data/registry/**
lang:zh:
- changed-files:
- any-glob-to-any-file:
- content/zh/**
lang:ja:
- changed-files:
- any-glob-to-any-file:
- content/ja/**
sig:cpp:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/cpp/**
sig:erlang:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/erlang/**
sig:go:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/go/**
sig:java:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/java/**
- content/en/docs/zero-code/java/**
sig:js:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/js/**
- content/en/docs/zero-code/js/**
sig:dotnet:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/net/**
- content/en/docs/zero-code/net/**
sig:php:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/php/**
- content/en/docs/zero-code/php/**
sig:python:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/python/**
- content/en/docs/zero-code/python/**
sig:ruby:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/ruby/**
sig:rust:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/rust/**
sig:swift:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/swift/**
sig:operator:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/kubernetes/operator/**
sig:helm:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/kubernetes/helm/**
sig:security:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/security/**
sig:demo:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/demo/**
sig:collector:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/collector/**
sig:enduser:
- changed-files:
- any-glob-to-any-file:
- content/en/community/end-user/**
sig:spec:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/specs/**
3 changes: 1 addition & 2 deletions .github/workflows/auto-update-versions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ jobs:
DEPTH: --depth 500 # submodule clone depth

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

- name: Use CLA approved github bot
run: |
Expand Down
15 changes: 15 additions & 0 deletions .github/workflows/check-i18n.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: i18n

on:
pull_request:

jobs:
i18n-check:
name: I18N check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # all
- run: scripts/i18n-check.sh -u
- run: .github/workflows/scripts/i18n-check-helper.sh
23 changes: 16 additions & 7 deletions .github/workflows/check-text.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,18 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# Make sure that we only install the dependencies for textlint to speed up install
- run: |
- name: Create and use reduced-dependencies package.json
run: |
mkdir -p tmp
jq '.devDependencies |= with_entries( select(.key | startswith("textlint")))
| del(.dependencies, .optionalDependencies)' \
package.json > tmp/package-min.json
cp tmp/package-min.json package.json
package.json > tmp/package-ci.json
cp tmp/package-ci.json package.json
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: tmp/package-ci.json
- run: npm install --ignore-scripts --omit=optional
- run: .github/workflows/scripts/textlint.sh

Expand All @@ -24,15 +29,19 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Create and use reduced-dependencies package.json
run: |
mkdir -p tmp
jq '.devDependencies |= with_entries(
select(.key | test("gulp|markdown|through|require|yargs"))
)
| del(.dependencies, .optionalDependencies)' \
package.json > tmp/package-min.json
cp tmp/package-min.json package.json
package.json > tmp/package-ci.json
cp tmp/package-ci.json package.json
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: tmp/package-ci.json
- run: npm install --ignore-scripts --omit=optional
- run: npm run check:markdown
16 changes: 16 additions & 0 deletions .github/workflows/label-prs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: 'Label PR'
on:
- pull_request_target

jobs:
labeler:
name: 'Add component labels'
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/labeler@v5
with:
configuration-path: '.github/component-label-map.yml'
10 changes: 5 additions & 5 deletions .github/workflows/pr-actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ jobs:
pull-requests: write

env:
DEPTH: --depth 100 # submodule clone depth
DEPTH: --depth 1000 # submodule clone depth

steps:
- name: Extract action name
id: extract_action_name
run: |
PR_ACTION=$(echo $COMMENT | grep -oP '/fix:\K\w+')
echo "Action is $PR_ACTION"
ACTION_NAMES="all|dict|filenames|format|markdown|refcache|submodules"
ACTION_NAMES="all|dict|filenames|format|i18n|markdown|refcache|submodules|text"
if [[ ! "$PR_ACTION" =~ ^($ACTION_NAMES)$ ]]; then
echo "Invalid action name: $PR_ACTION"
echo "Action name should be one of: $ACTION_NAMES"
Expand All @@ -50,11 +50,11 @@ jobs:
run: |
gh pr comment $PR_NUM -b "You triggered fix:${PR_ACTION} action run at $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"
env:
GH_TOKEN: ${{ github.token }}
GH_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}

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

- name: Create NPM cache-hash input file
run: |
Expand Down Expand Up @@ -106,4 +106,4 @@ jobs:
run: |
gh pr comment $PR_NUM -b "fix:${PR_ACTION} run failed, please check $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID for details"
env:
GH_TOKEN: ${{ github.token }}
GH_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
26 changes: 26 additions & 0 deletions .github/workflows/scripts/i18n-check-helper.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#!/bin/bash -e

echo "For localization docs, see https://opentelemetry.io/docs/contributing/localization"

CHANGES=`git status --porcelain`

if [[ -z $CHANGES ]]; then
echo "All localization pages have the requisit commit hash. <3"
exit;
fi

cat <<EOS
Some i18n pages are missing the 'default_lang_commit' front matter field.
To fix this in your local development environment, run
scripts/i18n-check.sh -u
and commit the changes for your locale. Here are the list of pages that
need to be updated:
---
EOS

echo "$CHANGES"
echo "---"

exit 1
15 changes: 8 additions & 7 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/cncf/docsy.git
docsy-pin = v0.9.1
docsy-reminder = "Ensure that all tags from google/docsy are also present in cncf/docsy, otherwise add (push) them."
url = https://github.com/google/docsy.git
docsy-pin = v0.10.0-6-g102892d
docsy-note = "2024-04-01 Switching to google/docsy.git from cncf/docsy.git since we don't have any CNCF customizations."
docsy-reminder = "Ensure that any tag referenced by `docsy-pin` is present in the remote repo (url), otherwise add (push) the tags to the repo."
[submodule "content-modules/opentelemetry-specification"]
path = content-modules/opentelemetry-specification
url = https://github.com/open-telemetry/opentelemetry-specification.git
spec-pin = v1.30.0
spec-pin = v1.33.0
[submodule "content-modules/community"]
path = content-modules/community
url = https://github.com/open-telemetry/community
community-pin = f16a58e
[submodule "content-modules/opentelemetry-proto"]
path = content-modules/opentelemetry-proto
url = https://github.com/open-telemetry/opentelemetry-proto
otlp-pin = v1.1.0
otlp-pin = v1.3.1
[submodule "content-modules/semantic-conventions"]
path = content-modules/semantic-conventions
url = https://github.com/open-telemetry/semantic-conventions
semconv-pin = v1.24.0
semconv-pin = v1.26.0
[submodule "content-modules/opamp-spec"]
path = content-modules/opamp-spec
url = https://github.com/open-telemetry/opamp-spec
opamp-pin = v0.8.0-5-g0360da8
opamp-pin = v0.9.0-2-g950df29
[submodule "content-modules/opentelemetry-go"]
path = content-modules/opentelemetry-go
url = https://github.com/open-telemetry/opentelemetry-go
Expand Down
14 changes: 9 additions & 5 deletions .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,18 @@ DirectoryPath: public
IgnoreDirectoryMissingTrailingSlash: true
IgnoreAltMissing: true
IgnoreCanonicalBrokenLinks: false
IgnoreInternalEmptyHash: true # TODO: remove after resolution of https://github.com/google/docsy/issues/1995
CheckMailto: false
TestFilesConcurrently: true
IgnoreDirs:
- ^blog/(\d+/)?page/\d+
IgnoreInternalURLs: # list of paths
IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^/docs/languages/\w+/(api|examples|registry)/$
- ^/docs/collector/registry/$
- ^/docs/languages/net/(metrics-api|traces-api)/
- ^/community/end-user/feedback-survey/$
- ^(/docs/migration/)?opencensus/$
- ^(/..)?/docs/languages/\w+/(api|examples|registry)/$
- ^(/..)?/docs/collector/registry/$
- ^(/..)?/docs/languages/net/(metrics-api|traces-api)/
- ^((/..)?/docs/migration/)?opencensus/$
- ^(/community/end-user/)?feedback-survey/$

- ^https://deploy-preview-\d+--opentelemetry.netlify.app/
- ^https://www\.googletagmanager\.com
Expand All @@ -33,8 +34,11 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^https://www.chathamhouse.org
- ^https://www.zocdoc.com
- ^https://x.com
- ^https://platform.openai.com
# OTel Google calendar - curl returns 200, but the link checker gets a 401:
- ^https://calendar.google.com/calendar/embed\?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com
# YouTube playlists sometimes give a 404, although they give a 200 when accessed via browser:
- ^https://www.youtube.com/playlist\?list=

# Ignore Docsy-generated GitHub links for now
- ^https?://github\.com/.*?/.*?/(new|edit)/ # view-page, edit-source etc
Expand Down
Loading

0 comments on commit 36804bb

Please sign in to comment.