Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into feat/language-apis-and-sdks
Browse files Browse the repository at this point in the history
emdneto authored Oct 21, 2024
2 parents 1f3770d + 0457368 commit 8040186
Showing 18 changed files with 300 additions and 52 deletions.
2 changes: 2 additions & 0 deletions .cspell.yml
Original file line number Diff line number Diff line change
@@ -53,3 +53,5 @@ dictionaries:
- softwareTerms
# Other
- companies
words: # Valid words across all locales
- htmltest
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/google/docsy.git
docsy-pin = v0.10.0-26-g79511949
docsy-pin = v0.11.0
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"]
10 changes: 6 additions & 4 deletions .htmltest.yml
Original file line number Diff line number Diff line change
@@ -7,11 +7,13 @@ IgnoreInternalEmptyHash: true # TODO: remove after resolution of https://github.
CheckMailto: false
TestFilesConcurrently: true
IgnoreDirs:
# DO NOT EDIT! IgnoreDirs list is auto-generated from markdown file front matter.
# TODO drop next line after https://github.com/open-telemetry/opentelemetry.io/issues/5423 is fixed for ja pages:
- ^ja/docs/concepts/instrumentation/libraries/
# TODO drop next line after https://github.com/open-telemetry/opentelemetry.io/issues/5423 is fixed for pt pages:
- ^pt/docs/concepts/instrumentation/libraries/
- ^blog/(\d+/)?page/\d+
# TODO drop after https://github.com/open-telemetry/opentelemetry.io/issues/5267 is fixed:
- zh/docs/contributing/pr-checks
# TODO drop after https://github.com/open-telemetry/opentelemetry.io/issues/5423 is fixed:
- (ja|pt)/docs/concepts/instrumentation/libraries/
# DO NOT EDIT! IgnoreDirs list is auto-generated from markdown file front matter.
IgnoreInternalURLs: # list of paths
IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^/api$
6 changes: 4 additions & 2 deletions content/en/blog/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Blog
menu:
main: { weight: 50 }
menu: { main: { weight: 50 } }
redirects: [{ from: '', to: '2024/ 301!' }]
outputs: [HTML, RSS]
htmltest:
IgnoreDirs:
- ^blog/(\d+/)?page/\d+
---
28 changes: 28 additions & 0 deletions content/en/docs/contributing/localization.md
Original file line number Diff line number Diff line change
@@ -11,6 +11,34 @@ English is the default language, with US English as the default (implicit) local
A growing number of other localizations are supported, as can be seen from the languages
dropdown menu in the top nav.

## English language maintainer guidance

### When link checking fails for non-English pages

English is the default language of the OpenTelemetry website. After you add,
edit, or reorganized English language documentation, link checking may fail for
non-English pages. When this happens:

<!-- markdownlint-disable blanks-around-fences -->

- Do **not** fix the broken links. Each non-English page is associated with a
specific commit of the corresponding English page, as identified by the git
commit hash value of the `default_lang_commit` front matter key.
- Configure the link checker to ignore the non-English pages by adding the
following to the page's front matter, or to the closest common ancestor file,
when more than one page has link errors:
```yaml
htmltest:
# TODO: remove the IgnoreDirs once broken links are fixed
IgnoreDirs:
- path-regex/to/non-en/directory/contain/files/to/ignore
- path-2-etc
```
- Run `npm run check:links` and include any updates to the `.htmltest.yml`
config file with your PR.

<!-- markdownlint-enable blanks-around-fences -->

## Translation guidance

We recommend that you follow the guidance offered in this section when
2 changes: 1 addition & 1 deletion content/en/docs/languages/java/_index.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ description: >-
aliases: [/java, /java/metrics, /java/tracing]
cascade:
vers:
instrumentation: 2.8.0
instrumentation: 2.9.0
otel: 1.43.0
contrib: 1.38.0
semconv: 1.28.0
4 changes: 4 additions & 0 deletions content/ja/docs/concepts/instrumentation/libraries.md
Original file line number Diff line number Diff line change
@@ -3,6 +3,10 @@ title: ライブラリ
description: ライブラリにネイティブ計装を追加する方法を紹介します。
weight: 40
default_lang_commit: d8c5612
htmltest:
IgnoreDirs:
# TODO drop next line after https://github.com/open-telemetry/opentelemetry.io/issues/5423 is fixed for ja pages:
- ^ja/docs/concepts/instrumentation/libraries/
---

OpenTelemetryは、多くのライブラリに[計装ライブラリ][instrumentation libraries]を提供していて、これは通常、ライブラリフックやモンキーパッチライブラリコードを通して行われます。
4 changes: 4 additions & 0 deletions content/pt/docs/concepts/instrumentation/libraries.md
Original file line number Diff line number Diff line change
@@ -3,6 +3,10 @@ title: Bibliotecas
description: Aprenda como adicionar instrumentação nativa à sua biblioteca.
weight: 40
default_lang_commit: a570a00c7a238ffe26528d7bfb20efdbaf939c39
htmltest:
IgnoreDirs:
# TODO drop next line after https://github.com/open-telemetry/opentelemetry.io/issues/5423 is fixed for pt pages:
- ^pt/docs/concepts/instrumentation/libraries/
---

O OpenTelemetry fornece [bibliotecas de instrumentação][] para várias
58 changes: 36 additions & 22 deletions content/zh/docs/contributing/style-guide.md
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@ description: 编写 OpenTelemetry 文档时的术语和风格指南。
linkTitle: 风格指南
weight: 20
cSpell:ignore: open-telemetry postgre style-guide textlintrc
default_lang_commit: d78e63a
default_lang_commit: 2394fa1f1c693e547093e46e83a6819d3c26e9d5
---

OpenTelemetry 还没有官方的风格指南,当前版本的 OpenTelemetry 文档风格受到以下风格指南的启发:
@@ -23,42 +23,52 @@ OpenTelemetry 还没有官方的风格指南,当前版本的 OpenTelemetry 文

{{% /alert %}}

## OpenTelemetry.io 单词列表
## OpenTelemetry.io 单词列表 {#opentelemetryio-word-list}

请在整个网站上统一使用以下 OpenTelemetry 特定术语和词语列表。

<!-- prettier-ignore-start -->

| Term | Usage |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OpenTelemetry | OpenTelemetry 应始终大写。请勿使用 Open-Telemetry。 |
| OTel | OTel 是 OpenTelemetry 的公认缩写形式。请勿使用 OTEL。 |
| Collector | 当引用 OpenTelemetry Collector 时,请始终将 Collector 大写。在句子开头请使用 `The Collector``The Opentelemetry Collector`, 在句中或句尾则使用 `the Collector``the OpenTelemetry Collector`。如果您要将 Collector 用作形容词(例如, `Collector 配置` ),请只使用 `Collector`|
| OTEP | OpenTelemetry 增强提案(OpenTelemetry Enhancement Proposal)。复数形式请写作 `OTEPs` 。请不要写成 `OTep``otep` |
| OpAMP | 开放代理管理协议(Open Agent Management Protocol)。请勿在描述或说明中写成 `OPAMP``opamp` |
| <!-- prettier-ignore-end --> | |
| 术语 | 用法 |
| ---- | ----- |
| OpenTelemetry | OpenTelemetry 应始终大写。请勿使用 Open-Telemetry。|
| OTel | OTel 是 OpenTelemetry 的公认缩写形式。请勿使用 OTEL。|
| Collector | 当引用 OpenTelemetry Collector 时,请始终将 Collector 大写。在句子开头请使用 `The Collector``The Opentelemetry Collector`, 在句中或句尾则使用 `the Collector``the OpenTelemetry Collector`。如果您要将 Collector 用作形容词(例如, `Collector 配置` ),请只使用 `Collector`|
| OTEP | OpenTelemetry 增强提案(OpenTelemetry Enhancement Proposal)。复数形式请写作 `OTEPs` 。请不要写成 `OTep``otep`|
| OpAMP | 开放代理管理协议(Open Agent Management Protocol)。请勿在描述或说明中写成 `OPAMP``opamp`|
<!-- prettier-ignore-end -->

确保正确书写专有名词(例如其他 CNCF 项目或第三方工具)并使用原始大写字母。例如,书写 `PostgreSQL` 而不是 `postgre`。有关完整列表,请查看 [`.textlintrc.yml`](https://github.com/open-telemetry/opentelemetry.io/blob/main/.textlintrc.yml) 文件。
确保正确书写专有名词(例如其他 CNCF 项目或第三方工具)并使用原始大写字母。例如,
书写 `PostgreSQL` 而不是 `postgre`。有关完整列表,请查看
[`.textlintrc.yml`](https://github.com/open-telemetry/opentelemetry.io/blob/main/.textlintrc.yml) 文件。

另请参阅 [词汇表](/docs/concepts/glossary/) 以获取 OpenTelemetry术语及其定义的列表。

运行 `npm run check:text` 命令以验证所有术语和单词是否书写正确。

运行 `npm run check:text -- --fix` 命令以修复书写不正确的术语和单词。

## Markdown 标准
## Markdown 标准 {#markdown-standards}

为了增强 Markdown 文件的标准性和一致性,所有文件都应遵循 [markdownlint](https://github.com/DavidAnson/markdownlint) 确定的相关规则。有关完整列表,请查看 [`.markdownlint.json`](https://github.com/open-telemetry/opentelemetry.io/blob/main/.markdownlint.json) 文件。
为了增强 Markdown 文件的标准性和一致性,所有文件都应遵循
[markdownlint](https://github.com/DavidAnson/markdownlint)
确定的相关规则。有关完整列表,请查看
[`.markdownlint.json`](https://github.com/open-telemetry/opentelemetry.io/blob/main/.markdownlint.json)
文件。

运行 `npm run check:markdown` 命令以验证所有文件是否遵循标准。

运行 `npm run fix:markdown` 命令以修复与 Markdown 相关的格式问题。

## 拼写检查
## 拼写检查 {#spell-checking}

使用 [CSpell](https://github.com/streetsidesoftware/cspell) 确保所有文本拼写正确。有关 OpenTelemetry 网站特定单词的列表,请参阅 [`.cspell.yml`](https://github.com/open-telemetry/opentelemetry.io/blob/main/.cspell.yml) 文件。
使用 [CSpell](https://github.com/streetsidesoftware/cspell) 确保所有文本拼写正确。
有关 OpenTelemetry 网站特定单词的列表,请参阅
[`.cspell.yml`](https://github.com/open-telemetry/opentelemetry.io/blob/main/.cspell.yml) 文件。

运行 `npm run check:spelling` 命令以验证所有单词拼写是否正确。如果 `cspell` 指示 `Unknown word` 错误,请验证您是否正确编写了该单词。如果正确,请将此单词添加到文件顶部的 `cSpell:ignore` 部分。如果不存在这样的部分,您可以将其添加到 Markdown 文件的元数据中:
运行 `npm run check:spelling` 命令以验证所有单词拼写是否正确。如果 `cspell` 指示
`Unknown word` 错误,请验证您是否正确编写了该单词。如果正确,请将此单词添加到文件顶部的
`cSpell:ignore` 部分。如果不存在这样的部分,您可以将其添加到 Markdown 文件的元数据中:

```markdown
---
@@ -67,19 +77,23 @@ cSpell:ignore: <word>
---
```

对于任何其他文件,请在适合文件上下文的注释行中添加 `cSpell:ignore <word>`。对于 [registry](/ecosystem/registry/) 条目 YAML 文件,它可能看起来像这样:
对于任何其他文件,请在适合文件上下文的注释行中添加 `cSpell:ignore <word>`
对于 [registry](/ecosystem/registry/) 条目 YAML 文件,它可能看起来像这样:

```yaml
# cSpell:ignore <word>
title: registryEntryTitle
```
网站工具通过移除重复单词、删除全局单词列表中的单词以及对单词进行排序来规范特定于页面的词典(即 `cSpell:ignore` 单词列表)。要规范特定于页面的词典,请运行 `npm run fix:dict`。
网站工具通过移除重复单词、删除全局单词列表中的单词以及对单词进行排序来规范特定于页面的词典(即
`cSpell:ignore` 单词列表)。要规范特定于页面的词典,请运行 `npm run fix:dict`。

## 文件格式
## 文件格式 {#file-format}

为了执行关于文件结构的特定标准,所有文件都应使用 [prettier](https://prettier.io) 进行格式化。在提交 PR 之前运行 `npm run fix:format`,或者在提交 PR 之后运行它并推送额外的提交。
为了执行关于文件结构的特定标准,所有文件都应使用 [prettier](https://prettier.io)
进行格式化。在提交 PR 之前运行 `npm run fix:format`,或者在提交 PR 之后运行它并推送额外的提交。

## 文件名
## 文件名 {#file-names}

所有文件名都应采用[短横线命名](https://en.wikipedia.org/wiki/Letter_case#Kebab_case)。运行 `npm run fix:filenames` 以自动重命名文件。
所有文件名都应采用[短横线命名](https://en.wikipedia.org/wiki/Letter_case#Kebab_case)。
运行 `npm run fix:filenames` 以自动重命名文件。
28 changes: 28 additions & 0 deletions data/registry/tools-java-druid-extension-otlp.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
title: Apache Druid extension for OTLP
registryType: utilities
language: java
tags:
- java
- druid
- utilities
- analytics
- dashboards
- monitoring
license: Apache 2.0
description: This extension allows [Apache Druid](https://druid.apache.org/) to
ingest OpenTelemetry signals.

An example setup would be to use the [Kafka
Exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/kafkaexporter/README.md)
to publish OTLP data into Kafka topics, and then setup Druid ingestion jobs,
using this extension, to populate tables.
authors:
- name: mishmash io
email: opensourcemaintainers@mishmash.io
url: https://mishmash.io
urls:
repo: https://github.com/mishmash-io/opentelemetry-server-embedded
docs: https://github.com/mishmash-io/opentelemetry-server-embedded/tree/main/druid-otlp-format
createdAt: 2024-10-17
isNative: false
isFirstParty: false
25 changes: 13 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{
"spelling": "cSpell:ignore docsy elemetry htmltest hugo loglevel netlify nowrap prebuild precheck preinstall postbuild postget refcache textlint -",
"Notes": [
"The 'all' runs _all_ named scripts in sequence, even if one fails; and exits with failure in that case."
],
@@ -86,8 +85,8 @@
"prebuild:preview": "npm run _prebuild",
"prebuild:production": "npm run _prebuild",
"prebuild": "npm run _prebuild",
"precheck:links:internal": "npm run build",
"precheck:links": "npm run build",
"precheck:links:internal": "npm run build && npm run update:htmltest-config",
"precheck:links": "npm run build && npm run update:htmltest-config",
"prefix:submodules": "npm run update:submodule",
"prenetlify-build:production": "echo 'IgnoreTagAttribute: rel' >> .htmltest.yml",
"prepare": "npm run seq -- get:submodule _prepare:docsy",
@@ -102,6 +101,7 @@
"test-and-fix": "npm run seq -- check fix:dict fix:filenames",
"test": "npm run check",
"update:docsy-dep": "npm install --save-dev autoprefixer@latest postcss-cli@latest",
"update:htmltest-config": "scripts/htmltest-config.sh",
"update:hugo": "npm install --save-dev --save-exact hugo-extended@latest",
"update:hugo+": "npm run update:hugo && npm run update:docsy-dep",
"update:netlify": "npm install --save-optional netlify-cli@latest",
@@ -111,23 +111,23 @@
"update:submodule": "set -x && git submodule update --remote ${DEPTH:- --depth 999}"
},
"devDependencies": {
"@cspell/dict-es-es": "^3.0.0",
"@cspell/dict-fr-fr": "^2.2.2",
"@cspell/dict-pt-br": "^2.3.0",
"@cspell/dict-es-es": "^3.0.3",
"@cspell/dict-fr-fr": "^2.2.5",
"@cspell/dict-pt-br": "^2.3.3",
"ajv": "^8.17.1",
"ajv-errors": "^3.0.0",
"ajv-formats": "^3.0.1",
"autoprefixer": "^10.4.20",
"cspell": "^8.14.4",
"cspell": "^8.15.4",
"gulp": "^5.0.0",
"hugo-extended": "0.133.0",
"hugo-extended": "0.136.2",
"js-yaml": "^4.1.0",
"markdown-link-check": "^3.12.2",
"markdownlint": "^0.35.0",
"postcss-cli": "^11.0.0",
"prettier": "^3.3.3",
"require-dir": "^1.2.0",
"textlint": "^14.2.0",
"textlint": "^14.2.1",
"textlint-filter-rule-allowlist": "^4.0.0",
"textlint-filter-rule-comments": "^1.2.2",
"textlint-rule-terminology": "^5.2.12",
@@ -148,8 +148,8 @@
"path": "^0.12.7"
},
"optionalDependencies": {
"netlify-cli": "^17.36.4",
"npm-check-updates": "^17.1.3"
"netlify-cli": "^17.37.1",
"npm-check-updates": "^17.1.4"
},
"enginesComment": "Ensure that engines.node value stays consistent with the project's .nvmrc",
"engines": {
@@ -160,5 +160,6 @@
"prettier": {
"proseWrap": "always",
"singleQuote": true
}
},
"spelling": "cSpell:ignore docsy elemetry htmltest hugo loglevel netlify nowrap postnetlify prebuild precheck preinstall postbuild postget refcache textlint -"
}
12 changes: 6 additions & 6 deletions scripts/content-modules/adjust-pages.pl
Original file line number Diff line number Diff line change
@@ -127,15 +127,15 @@ ()
# Images
s|(\.\./)?internal(/img/[-\w]+\.png)|$2|g;
s|(\]\()(img/.*?\))|$1../$2|g if $ARGV !~ /(logs|schemas)._index/ && $ARGV !~ /otlp\/docs/;
s|(\]\()([^)]+\.png\))|$1../$2|g if $ARGV =~ /\/tmp\/semconv\/docs\/general\/attributes/;
s|(\]\()([^)]+\.png\))|$1../$2|g if $ARGV =~ /\/tmp\/semconv\/docs\/http\/http-spans/;
s|(\]\()([^)]+\.png\))|$1../$2|g if $ARGV =~ /\btmp\/semconv\/docs\/general\/attributes/;
s|(\]\()([^)]+\.png\))|$1../$2|g if $ARGV =~ /\btmp\/semconv\/docs\/http\/http-spans/;

s|\.\.\/README.md\b|$otelSpecRepoUrl/|g if $ARGV =~ /specification._index/;
s|\.\.\/README.md\b|..| if $ARGV =~ /specification.library-guidelines.md/;

s|\.\./(opentelemetry/proto/?.*)|$otlpSpecRepoUrl/tree/v$otlpSpecVers/$1|g if $ARGV =~ /\/tmp\/otlp/;
s|\.\./README.md\b|$otlpSpecRepoUrl/|g if $ARGV =~ /\/tmp\/otlp/;
s|\.\./examples/README.md\b|$otlpSpecRepoUrl/tree/v$otlpSpecVers/examples/|g if $ARGV =~ /\/tmp\/otlp/;
s|\.\./(opentelemetry/proto/?.*)|$otlpSpecRepoUrl/tree/v$otlpSpecVers/$1|g if $ARGV =~ /\btmp\/otlp/;
s|\.\./README.md\b|$otlpSpecRepoUrl/|g if $ARGV =~ /\btmp\/otlp/;
s|\.\./examples/README.md\b|$otlpSpecRepoUrl/tree/v$otlpSpecVers/examples/|g if $ARGV =~ /\btmp\/otlp/;

s|\bREADME.md\b|_index.md|g if $ARGV !~ /otel\/specification\/protocol\/_index.md/;

@@ -144,7 +144,7 @@ ()
s|(\.\.\/)+(supplementary-guidelines\/compatibility\/[^)]+)|$otelSpecRepoUrl/tree/v$otelSpecVers/$2|g;

# Rewrite inline links
if ($ARGV =~ /\/tmp\/opamp/) {
if ($ARGV =~ /\btmp\/opamp/) {
s|\]\(([^:\)]*?)\.md((#.*?)?)\)|]($1/$2)|g;
} else {
s|\]\(([^:\)]*?\.md(#.*?)?)\)|]({{% relref "$1" %}})|g;
4 changes: 2 additions & 2 deletions scripts/content-modules/cp-pages.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

SCRIPT_DIR="$(cd `dirname $0`; pwd)"
DEST_BASE="$(cd $SCRIPT_DIR; cd ../../; pwd)/tmp"
SCRIPT_DIR=$(dirname $0)
DEST_BASE=tmp

## OTel specification

Loading

0 comments on commit 8040186

Please sign in to comment.