Skip to content

Commit

Permalink
Merge branch 'main' into ja/docs/getting-started/dev
Browse files Browse the repository at this point in the history
  • Loading branch information
Yoshi Yamaguchi authored Jun 10, 2024
2 parents 00a203f + c2cd5b1 commit 7ceca8f
Show file tree
Hide file tree
Showing 20 changed files with 159 additions and 109 deletions.
10 changes: 5 additions & 5 deletions .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ IgnoreDirs:
- ^blog/(\d+/)?page/\d+
IgnoreInternalURLs: # list of paths
IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^(/zh)?/docs/languages/\w+/(api|examples|registry)/$
- ^(/zh)?/docs/collector/registry/$
- ^(/zh)?/docs/languages/net/(metrics-api|traces-api)/
- ^((/zh)?/docs/migration/)?opencensus/$
- ^/community/end-user/feedback-survey/$
- ^(/..)?/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 Down
12 changes: 6 additions & 6 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ show_banner: true

<div class="l-primary-buttons mt-5">

- [Learn more](/docs/what-is-opentelemetry/)
- [Try the demo](/docs/demo/)
- [Explore integrations](/ecosystem/integrations)
- [Learn more](docs/what-is-opentelemetry/)
- [Try the demo](docs/demo/)
- [Explore integrations](/ecosystem/integrations/)

</div>

Expand All @@ -37,8 +37,8 @@ show_banner: true
</div>
<div class="l-get-started-buttons">

- [Dev](/docs/getting-started/dev/)
- [Ops](/docs/getting-started/ops/)
- [Dev](docs/getting-started/dev/)
- [Ops](docs/getting-started/ops/)

</div>
{{< /blocks/cover >}}
Expand All @@ -50,7 +50,7 @@ generate, collect, and export telemetry data (metrics, logs, and traces) to help
you analyze your software's performance and behavior.

> OpenTelemetry is **generally available** across
> [several languages](/docs/languages/) and is suitable for use.
> [several languages](docs/languages/) and is suitable for use.
{{% /blocks/lead %}}

Expand Down
2 changes: 1 addition & 1 deletion content/en/community/end-user/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ right place!
[OpenTelemetry YouTube channel](https://www.youtube.com/@otel-official)
- To provide feedback and help prioritize issues:
- Participate in a [direct interview/feedback session](interviews-feedback/)
- Take a [survey](/community/end-user/feedback-survey/)
- Take a [survey](feedback-survey/)
- Join a panel discussion (more info coming soon!)
- Vote on issues (more info coming soon!)

Expand Down
9 changes: 4 additions & 5 deletions content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,12 @@ aliases: [/docs/workshop/*]
OpenTelemetry, also known as OTel, is a vendor-neutral open source
[Observability](concepts/observability-primer/#what-is-observability) framework
for instrumenting, generating, collecting, and exporting telemetry data such as
[traces](/docs/concepts/signals/traces/),
[metrics](/docs/concepts/signals/metrics/), and
[logs](/docs/concepts/signals/logs/).
[traces](concepts/signals/traces/), [metrics](concepts/signals/metrics/), and
[logs](concepts/signals/logs/).

As an industry-standard, OpenTelemetry is
[supported by more than 40 observability vendors](/ecosystem/vendors/),
integrated by many [libraries, services, and apps](/ecosystem/integrations), and
adopted by [numerous end users](/ecosystem/adopters).
integrated by many [libraries, services, and apps](/ecosystem/integrations/),
and adopted by [numerous end users](/ecosystem/adopters/).

![OpenTelemetry Reference Architecture](/img/otel-diagram.svg)
4 changes: 2 additions & 2 deletions content/en/docs/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ observability with OpenTelemetry looks like!

</div>

[^1]: If none of these roles apply to you, [let us know!][].
[^1]: If none of these roles apply to you, [let us know][].

[demo]: /ecosystem/demo/
[let us know!]:
[let us know]:
https://github.com/open-telemetry/opentelemetry.io/issues/new?title=Add%20a%20new%20persona:%20My%20Persona&body=Provide%20a%20description%20of%20your%20role%20and%20responsibilities%20and%20what%20your%20observability%20goals%20are
34 changes: 17 additions & 17 deletions content/en/docs/getting-started/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,27 @@ OpenTelemetry can help you! To accomplish your goals of having your dependencies
instrumented automatically and instrumenting your own code with our API
manually, we recommend that you learn the following concepts first:

- [What is OpenTelemetry?](/docs/what-is-opentelemetry/)
- [How can I add instrumentation to my code base?](/docs/concepts/instrumentation/code-based/)
- [What is OpenTelemetry?](../../what-is-opentelemetry/)
- [How can I add instrumentation to my code base?](../../concepts/instrumentation/code-based/)

If you develop libraries, frameworks or middleware that is used as a dependency
within other software, we recommend that you learn how you can provide telemetry
natively:

- [How can I add native instrumentation to my library?](/docs/concepts/instrumentation/libraries/)
- [How can I add native instrumentation to my library?](../../concepts/instrumentation/libraries/)

Next, you can deep dive into the documentations for the
[language](/docs/languages/) you are using:

- [C++](/docs/languages/cpp/)
- [.NET](/docs/languages/net/)
- [Erlang / Elixir](/docs/languages/erlang/)
- [Go](/docs/languages/go/)
- [Java](/docs/languages/java/)
- [JavaScript / TypeScript](/docs/languages/js/)
- [PHP](/docs/languages/php/)
- [Python](/docs/languages/python/)
- [Ruby](/docs/languages/ruby/)
- [Rust](/docs/languages/rust/)
- [Swift](/docs/languages/swift/)
- [Other](/docs/languages/other/)
[language](../../languages/) you are using:

- [C++](../../languages/cpp/)
- [.NET](../../languages/net/)
- [Erlang / Elixir](../../languages/erlang/)
- [Go](../../languages/go/)
- [Java](../../languages/java/)
- [JavaScript / TypeScript](../../languages/js/)
- [PHP](../../languages/php/)
- [Python](../../languages/python/)
- [Ruby](../../languages/ruby/)
- [Rust](../../languages/rust/)
- [Swift](../../languages/swift/)
- [Other](../../languages/other/)
10 changes: 5 additions & 5 deletions content/en/docs/getting-started/ops.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ OpenTelemetry can help you! To accomplish your goal of getting telemetry out of
applications without touching their code, we recommend that you learn the
following:

- [What is OpenTelemetry?](/docs/what-is-opentelemetry/)
- [How can I instrument applications without touching their code?](/docs/concepts/instrumentation/zero-code/)
- [How can I set up a collector?](/docs/collector/)
- [How can I get automation for Kubernetes with the OpenTelemetry Operator?](/docs/kubernetes/operator/)
- [What is OpenTelemetry?](../../what-is-opentelemetry/)
- [How can I instrument applications without touching their code?](../../concepts/instrumentation/zero-code/)
- [How can I set up a collector?](../../collector/)
- [How can I get automation for Kubernetes with the OpenTelemetry Operator?](../../kubernetes/operator/)

If you are looking for a set of applications to try things out, you will find
our official [OpenTelemetry demo](/ecosystem/demo/) useful!
our official [OpenTelemetry demo](/ecosystem/demo/) useful.
3 changes: 1 addition & 2 deletions content/ja/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
title: OpenTelemetry
description: >-
効果的な観測を可能にする、高品質でユビキタスかつポータブルなテレメトリー
developer_note:
blocks/coverコラム(以下で使用)は、ファイル名に "background" を含む画像ファイルを背景画像として使用します。
developer_note: blocks/coverコラム(以下で使用)は、ファイル名に "background" を含む画像ファイルを背景画像として使用します。
show_banner: true
default_lang_commit: 902043db
---
Expand Down
4 changes: 2 additions & 2 deletions content/ja/docs/what-is-opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ OpenTelemetryの主な目的は、あなたのアプリケーションやシス

OpenTelemetryは、2つの重要な原則に従いながら、オブザーバビリティの需要を満たしています。

1. あなたが生成したデータはあなたのものです。ベンダーのロックインはありません。
2. APIと規約は1セットだけ覚えれば良いです。
1. あなたが生成したデータはあなたのものです。ベンダーのロックインはありません。
2. APIと規約は1セットだけ覚えれば良いです。

この2つの原則を組み合わせることで、現代のコンピューティングの世界で必要とされる柔軟性をチームや組織に与えられます。

Expand Down
24 changes: 12 additions & 12 deletions content/zh/docs/demo/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,18 @@ default_lang_commit: b7ee690154aacc8d6e43636af00743994fb6dc27

想要了解特定编程语言的工具是如何工作的?从这里开始:

| 语言 | 自动插桩 | 插桩库 | 手动插桩 |
| ---------- | ------------------- | -------------------- | ------------------------------------ |
| .NET | | [购物车服务](services/cart/) | [购物车服务](services/cart/) |
| C++ | | | [货币服务](services/currency/) |
| Go | | [会计服务](services/accounting/)[结账服务](services/checkout/)[产品目录服务](services/product-catalog/) | [结账服务](services/checkout/)[产品目录服务](services/product-catalog/) |
| Java | [广告服务](services/ad/) | | [广告服务](services/ad/) |
| JavaScript | | [前端](services/frontend/) | [前端](services/frontend/)[支付服务](services/payment/) |
| Kotlin | | [欺诈检测服务](services/fraud-detection/) | |
| PHP | | [报价服务](services/quote/) | [报价服务](services/quote/) |
| Python | [推荐服务](services/recommendation/) | | [推荐服务](services/recommendation/) |
| Ruby | | [电子邮件服务](services/email/) | [电子邮件服务](services/email/) |
| Rust | | [发货服务](services/shipping/) | [发货服务](services/shipping/) |
| 语言 | 自动插桩 | 插桩库 | 手动插桩 |
| ---------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| .NET | | [购物车服务](services/cart/) | [购物车服务](services/cart/) |
| C++ | | | [货币服务](services/currency/) |
| Go | | [会计服务](services/accounting/)[结账服务](services/checkout/)[产品目录服务](services/product-catalog/) | [结账服务](services/checkout/)[产品目录服务](services/product-catalog/) |
| Java | [广告服务](services/ad/) | | [广告服务](services/ad/) |
| JavaScript | | [前端](services/frontend/) | [前端](services/frontend/)[支付服务](services/payment/) |
| Kotlin | | [欺诈检测服务](services/fraud-detection/) | |
| PHP | | [报价服务](services/quote/) | [报价服务](services/quote/) |
| Python | [推荐服务](services/recommendation/) | | [推荐服务](services/recommendation/) |
| Ruby | | [电子邮件服务](services/email/) | [电子邮件服务](services/email/) |
| Rust | | [发货服务](services/shipping/) | [发货服务](services/shipping/) |

## 服务文档

Expand Down
2 changes: 1 addition & 1 deletion data/registry/exporter-dotnet-console.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ createdAt: 2022-11-07
package:
registry: nuget
name: OpenTelemetry.Exporter.Console
version: 1.9.0-alpha.1
version: 1.9.0-rc.1
2 changes: 1 addition & 1 deletion data/registry/exporter-dotnet-inmemory.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ createdAt: 2022-11-07
package:
registry: nuget
name: OpenTelemetry.Exporter.InMemory
version: 1.9.0-alpha.1
version: 1.9.0-rc.1
6 changes: 5 additions & 1 deletion data/registry/instrumentation-js-azure-sdk.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,9 @@ description: Instrumentation for Azure SDK for JavaScript (Track 2 libraries).
authors:
- name: Microsoft Authors
urls:
repo: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core#open-telemetry
repo: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/instrumentation/opentelemetry-instrumentation-azure-sdk
package:
name: '@azure/opentelemetry-instrumentation-azure-sdk'
registry: npm
version: 1.0.0-beta.5
createdAt: 2021-12-16
1 change: 1 addition & 0 deletions data/registry/instrumentation-js-langchain.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ createdAt: 2024-06-05
package:
registry: npm
name: '@arizeai/openinference-instrumentation-langchain'
version: 0.0.6
1 change: 1 addition & 0 deletions data/registry/instrumentation-js-openai.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ createdAt: 2024-06-05
package:
registry: npm
name: '@arizeai/openinference-instrumentation-openai'
version: 0.3.1
33 changes: 28 additions & 5 deletions gulp-src/lint-md.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ const markdownlint = require('markdownlint');
const { taskArgs, trimBlankLinesFromArray } = require('./_util');
const fs = require('fs');

const defaultGlob = '**/*.md';
const defaultGlobs = ['**/*.md'];
const markdownFiles = [
'!.github/**',
'!content-modules/**',
'!examples/**',
'!layouts/**',
'!node_modules/**',
'!scripts/registry-scanner/node_modules/**',
'!tools/examples/**',
'!themes/**',
'!tmp/**',
];
Expand Down Expand Up @@ -121,13 +123,28 @@ function applyFixesToFileContent(content, issue) {
return lines.join('\n');
}

function logFiles(debug) {
return through2.obj(function (file, enc, cb) {
if (debug) {
console.log('Processing file:', file.path);
}
cb(null, file);
});
}

function lintMarkdown() {
const argv = taskArgs().options({
glob: {
alias: 'g',
type: 'string',
description: 'Glob of files to run through markdownlint.',
default: defaultGlob,
type: 'array',
description:
'Globs of files to run through markdownlint. List flag more than once for multiple values.',
default: defaultGlobs,
},
debug: {
type: 'boolean',
description: 'Output debugging information.',
default: false,
},
fix: {
type: 'boolean',
Expand All @@ -142,8 +159,14 @@ function lintMarkdown() {
}
fix = argv.fix;

const globs = [...argv.glob, ...markdownFiles];
if (argv.debug) {
console.log('Globs being used:', globs);
}

return gulp
.src([argv.glob, ...markdownFiles])
.src(globs, { followSymlinks: false })
.pipe(logFiles(argv.debug))
.pipe(through2.obj(markdownLintFile))
.on('end', () => {
const fileOrFiles = 'file' + (numFilesProcessed == 1 ? '' : 's');
Expand Down
46 changes: 24 additions & 22 deletions hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -210,50 +210,52 @@ security:

module:
mounts:
## en
- source: content/en
target: content
- source: tmp/community/mission-vision-values.md
target: content/community/mission.md
- source: tmp/community/roadmap.md
target: content/community/roadmap.md
# Specs, currently en only
- source: tmp/otel/specification
target: content/docs/specs/otel
- source: tmp/opamp
target: content/docs/specs/opamp
- source: tmp/otlp/docs/specification.md
target: content/docs/specs/otlp/_index.md
- source: tmp/otlp/docs/img
target: content/docs/specs/otlp/img
- source: tmp/semconv/docs
target: content/docs/specs/semconv

## ja
- source: content/ja
target: content
lang: ja
# fallback pages
# - excludeFiles: specs/*
# source: content/en/docs
# target: content/docs
# lang: ja
- source: content/en/announcements
target: content/announcements
lang: ja
- excludeFiles: specs/*
source: content/en/docs
target: content/docs
lang: ja

## zh
- source: content/zh
target: content
lang: zh
# fallback pages
- source: content/en/announcements
target: content/announcements
lang: zh
- excludeFiles: specs/*
source: content/en/docs
target: content/docs
lang: zh
- source: content/en/announcements
target: content/announcements
lang: zh

# Other site content
- source: tmp/otel/specification
target: content/docs/specs/otel
- source: tmp/opamp
target: content/docs/specs/opamp
- source: tmp/otlp/docs/specification.md
target: content/docs/specs/otlp/_index.md
- source: tmp/otlp/docs/img
target: content/docs/specs/otlp/img
- source: tmp/semconv/docs
target: content/docs/specs/semconv
- source: tmp/community/mission-vision-values.md
target: content/community/mission.md
- source: tmp/community/roadmap.md
target: content/community/roadmap.md
## static
- source: static
target: static
- source: content-modules/semantic-conventions/schemas
Expand Down
Loading

0 comments on commit 7ceca8f

Please sign in to comment.