From e7a62891accc831de331336c8d10245969276112 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Sat, 8 Jun 2024 15:10:17 -0400 Subject: [PATCH] [i18n & ja] Improved fallback config and normalize `en` doc links (#4627) --- .htmltest.yml | 10 ++--- content/en/_index.md | 12 +++--- content/en/community/end-user/_index.md | 2 +- content/en/docs/_index.md | 9 ++--- content/en/docs/getting-started/_index.md | 4 +- content/en/docs/getting-started/dev.md | 34 ++++++++--------- content/en/docs/getting-started/ops.md | 10 ++--- hugo.yaml | 46 ++++++++++++----------- 8 files changed, 64 insertions(+), 63 deletions(-) diff --git a/.htmltest.yml b/.htmltest.yml index e45612215caf..53e80a8d75fb 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -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 diff --git a/content/en/_index.md b/content/en/_index.md index 7c5a575641a1..cefdbafdd3bc 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -26,9 +26,9 @@ show_banner: true
-- [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/)
@@ -37,8 +37,8 @@ show_banner: true
-- [Dev](/docs/getting-started/dev/) -- [Ops](/docs/getting-started/ops/) +- [Dev](docs/getting-started/dev/) +- [Ops](docs/getting-started/ops/)
{{< /blocks/cover >}} @@ -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 %}} diff --git a/content/en/community/end-user/_index.md b/content/en/community/end-user/_index.md index 584d363b9b36..3d0d1e724d1f 100644 --- a/content/en/community/end-user/_index.md +++ b/content/en/community/end-user/_index.md @@ -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!) diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md index 2b776e2f0d49..65a0abee5c2c 100644 --- a/content/en/docs/_index.md +++ b/content/en/docs/_index.md @@ -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) diff --git a/content/en/docs/getting-started/_index.md b/content/en/docs/getting-started/_index.md index 2b60257680a5..b90ad2b72f5b 100644 --- a/content/en/docs/getting-started/_index.md +++ b/content/en/docs/getting-started/_index.md @@ -23,8 +23,8 @@ observability with OpenTelemetry looks like! -[^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 diff --git a/content/en/docs/getting-started/dev.md b/content/en/docs/getting-started/dev.md index 63063e4f9a96..73c8175a320a 100644 --- a/content/en/docs/getting-started/dev.md +++ b/content/en/docs/getting-started/dev.md @@ -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/) diff --git a/content/en/docs/getting-started/ops.md b/content/en/docs/getting-started/ops.md index 24a16a0d0980..ac60198d37fa 100644 --- a/content/en/docs/getting-started/ops.md +++ b/content/en/docs/getting-started/ops.md @@ -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. diff --git a/hugo.yaml b/hugo.yaml index 1a6f0a96cc1e..ef5eb3f2a0de 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -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