From 8e23d7886ef892ef29bb652bf44c917bd30e7580 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Fri, 7 Jun 2024 17:35:39 -0400 Subject: [PATCH 1/6] [i18n] Fallback to en for ja docs; en docs link normalization --- .htmltest.yml | 8 ++++---- content/en/_index.md | 2 +- content/en/docs/_index.md | 9 ++++----- hugo.yaml | 8 ++++---- 4 files changed, 13 insertions(+), 14 deletions(-) diff --git a/.htmltest.yml b/.htmltest.yml index e45612215caf..163d7d87e676 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -10,10 +10,10 @@ 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/$ + - ^(/..)?/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/ diff --git a/content/en/_index.md b/content/en/_index.md index 7c5a575641a1..41a73481b875 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -28,7 +28,7 @@ show_banner: true - [Learn more](/docs/what-is-opentelemetry/) - [Try the demo](/docs/demo/) -- [Explore integrations](/ecosystem/integrations) +- [Explore integrations](/ecosystem/integrations/) 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/hugo.yaml b/hugo.yaml index 1a6f0a96cc1e..670868f6e80e 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -218,10 +218,10 @@ module: target: content lang: ja # fallback pages - # - excludeFiles: specs/* - # source: content/en/docs - # target: content/docs - # lang: ja + - excludeFiles: specs/* + source: content/en/docs + target: content/docs + lang: ja - source: content/en/announcements target: content/announcements lang: ja From 66de73228f4019d1791fc94004f1f2ce988ecaa5 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Fri, 7 Jun 2024 17:49:32 -0400 Subject: [PATCH 2/6] More en link normalization --- content/en/_index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/_index.md b/content/en/_index.md index 41a73481b875..cefdbafdd3bc 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -26,8 +26,8 @@ show_banner: true
-- [Learn more](/docs/what-is-opentelemetry/) -- [Try the demo](/docs/demo/) +- [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 %}} From f24b4943a53354ea0dce9ea7b5535874e8ca6dd6 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Fri, 7 Jun 2024 18:17:14 -0400 Subject: [PATCH 3/6] More --- .htmltest.yml | 2 +- content/en/community/end-user/_index.md | 2 +- content/en/ecosystem/_index.md | 2 +- content/ja/ecosystem/_index.md | 12 ++++++++++++ hugo.yaml | 22 +++++++++++----------- 5 files changed, 26 insertions(+), 14 deletions(-) create mode 100644 content/ja/ecosystem/_index.md diff --git a/.htmltest.yml b/.htmltest.yml index 163d7d87e676..53e80a8d75fb 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -14,7 +14,7 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored - ^(/..)?/docs/collector/registry/$ - ^(/..)?/docs/languages/net/(metrics-api|traces-api)/ - ^((/..)?/docs/migration/)?opencensus/$ - - ^/community/end-user/feedback-survey/$ + - ^(/community/end-user/)?feedback-survey/$ - ^https://deploy-preview-\d+--opentelemetry.netlify.app/ - ^https://www\.googletagmanager\.com 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/ecosystem/_index.md b/content/en/ecosystem/_index.md index 8b08467f1a32..5160dd7d2015 100644 --- a/content/en/ecosystem/_index.md +++ b/content/en/ecosystem/_index.md @@ -1,7 +1,7 @@ --- title: OpenTelemetry Ecosystem linkTitle: Ecosystem -description: >- +description: > OpenTelemetry's thriving ecosystem of components, examples, integrations and vendors cascade: { type: docs } diff --git a/content/ja/ecosystem/_index.md b/content/ja/ecosystem/_index.md new file mode 100644 index 000000000000..c6fc8cb7a02b --- /dev/null +++ b/content/ja/ecosystem/_index.md @@ -0,0 +1,12 @@ +--- +title: OpenTelemetry Ecosystem +linkTitle: Ecosystem +description: > + OpenTelemetry's thriving ecosystem of components, examples, integrations and + vendors +cascade: { type: docs } +menu: { main: { weight: 20 } } +redirect: /ecosystem/ +_build: { render: link } +default_lang_commit: a575dfdbcd64b6d7b70b8fea9f9cabca602ddc04 +--- diff --git a/hugo.yaml b/hugo.yaml index 670868f6e80e..2ef5e6fab6ff 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -218,12 +218,12 @@ module: target: content lang: ja # fallback pages - - excludeFiles: specs/* - source: content/en/docs - target: content/docs - lang: ja - - source: content/en/announcements - target: content/announcements + - source: content/en + target: content + excludeFiles: &fallbackExcludeFiles + - docs/specs/* + - ecosystem/* + - site lang: ja ## zh @@ -231,12 +231,12 @@ module: target: content lang: zh # fallback pages - - excludeFiles: specs/* - source: content/en/docs - target: content/docs + - source: content/en + target: content + excludeFiles: *fallbackExcludeFiles lang: zh - - source: content/en/announcements - target: content/announcements + - source: content/ja/ecosystem + target: content lang: zh # Other site content From f9d46aa2e876a5ed172871670bcfc34b264e6bd5 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Fri, 7 Jun 2024 18:58:20 -0400 Subject: [PATCH 4/6] New config and rollback ja/ecosystem redirect --- content/en/ecosystem/_index.md | 2 +- content/ja/ecosystem/_index.md | 12 ------------ hugo.yaml | 15 +++++++-------- 3 files changed, 8 insertions(+), 21 deletions(-) delete mode 100644 content/ja/ecosystem/_index.md diff --git a/content/en/ecosystem/_index.md b/content/en/ecosystem/_index.md index 5160dd7d2015..8b08467f1a32 100644 --- a/content/en/ecosystem/_index.md +++ b/content/en/ecosystem/_index.md @@ -1,7 +1,7 @@ --- title: OpenTelemetry Ecosystem linkTitle: Ecosystem -description: > +description: >- OpenTelemetry's thriving ecosystem of components, examples, integrations and vendors cascade: { type: docs } diff --git a/content/ja/ecosystem/_index.md b/content/ja/ecosystem/_index.md deleted file mode 100644 index c6fc8cb7a02b..000000000000 --- a/content/ja/ecosystem/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: OpenTelemetry Ecosystem -linkTitle: Ecosystem -description: > - OpenTelemetry's thriving ecosystem of components, examples, integrations and - vendors -cascade: { type: docs } -menu: { main: { weight: 20 } } -redirect: /ecosystem/ -_build: { render: link } -default_lang_commit: a575dfdbcd64b6d7b70b8fea9f9cabca602ddc04 ---- diff --git a/hugo.yaml b/hugo.yaml index 2ef5e6fab6ff..4912acbd380e 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -212,6 +212,10 @@ module: mounts: - 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 ## ja - source: content/ja @@ -221,9 +225,11 @@ module: - source: content/en target: content excludeFiles: &fallbackExcludeFiles + - blog/* + - community/* - docs/specs/* - ecosystem/* - - site + - site/* lang: ja ## zh @@ -235,9 +241,6 @@ module: target: content excludeFiles: *fallbackExcludeFiles lang: zh - - source: content/ja/ecosystem - target: content - lang: zh # Other site content - source: tmp/otel/specification @@ -250,10 +253,6 @@ module: 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 - source: static target: static - source: content-modules/semantic-conventions/schemas From 414e7b6e3e82ee57ed4dd34942b1cb05cc2f00df Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Sat, 8 Jun 2024 04:58:32 -0400 Subject: [PATCH 5/6] Revert to previous strategy for fallback pg mounting --- hugo.yaml | 47 +++++++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 22 deletions(-) diff --git a/hugo.yaml b/hugo.yaml index 4912acbd380e..ef5eb3f2a0de 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -210,26 +210,36 @@ 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 - - source: content/en - target: content - excludeFiles: &fallbackExcludeFiles - - blog/* - - community/* - - docs/specs/* - - ecosystem/* - - site/* + - source: content/en/announcements + target: content/announcements + lang: ja + - excludeFiles: specs/* + source: content/en/docs + target: content/docs lang: ja ## zh @@ -237,22 +247,15 @@ module: target: content lang: zh # fallback pages - - source: content/en - target: content - excludeFiles: *fallbackExcludeFiles + - source: content/en/announcements + target: content/announcements + lang: zh + - excludeFiles: specs/* + source: content/en/docs + target: content/docs 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 + ## static - source: static target: static - source: content-modules/semantic-conventions/schemas From 23991427e15d88456a2abcaac14bceda20c0e987 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Sat, 8 Jun 2024 05:24:18 -0400 Subject: [PATCH 6/6] More link normalization + copyedits --- content/en/docs/getting-started/_index.md | 4 +-- content/en/docs/getting-started/dev.md | 34 +++++++++++------------ content/en/docs/getting-started/ops.md | 10 +++---- 3 files changed, 24 insertions(+), 24 deletions(-) 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.