From e742de50dd94117d2c1304ef226809dab293c659 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Mon, 17 Feb 2025 19:04:19 -0500 Subject: [PATCH 1/3] [i18n] Make `instrumentation-intro` shortcode a simple include --- content/en/docs/languages/_includes/_index.md | 5 +++++ .../en/docs/languages/_includes}/instrumentation-intro.md | 4 ++++ content/en/docs/languages/cpp/instrumentation.md | 2 +- content/en/docs/languages/erlang/instrumentation.md | 2 +- content/en/docs/languages/go/instrumentation.md | 2 +- content/en/docs/languages/js/instrumentation.md | 2 +- content/en/docs/languages/net/instrumentation.md | 2 +- content/en/docs/languages/php/instrumentation.md | 2 +- content/en/docs/languages/python/instrumentation.md | 2 +- content/en/docs/languages/ruby/instrumentation.md | 2 +- content/en/docs/languages/swift/instrumentation.md | 2 +- content/es/docs/languages/_includes/_index.md | 6 ++++++ .../es/docs/languages/_includes}/instrumentation-intro.md | 5 +++++ content/es/docs/languages/python/instrumentation.md | 2 +- content/pt/docs/languages/_includes/_index.md | 6 ++++++ .../pt/docs/languages/_includes}/instrumentation-intro.md | 5 +++-- content/pt/docs/languages/go/instrumentation.md | 2 +- 17 files changed, 40 insertions(+), 13 deletions(-) create mode 100644 content/en/docs/languages/_includes/_index.md rename {layouts/shortcodes/docs/languages => content/en/docs/languages/_includes}/instrumentation-intro.md (95%) create mode 100644 content/es/docs/languages/_includes/_index.md rename {layouts/shortcodes/es/docs/languages => content/es/docs/languages/_includes}/instrumentation-intro.md (89%) create mode 100644 content/pt/docs/languages/_includes/_index.md rename {layouts/shortcodes/pt/docs/languages => content/pt/docs/languages/_includes}/instrumentation-intro.md (96%) diff --git a/content/en/docs/languages/_includes/_index.md b/content/en/docs/languages/_includes/_index.md new file mode 100644 index 000000000000..3ac9b0ca3777 --- /dev/null +++ b/content/en/docs/languages/_includes/_index.md @@ -0,0 +1,5 @@ +--- +title: # bogus for markdownlint +cascade: + build: { list: never, render: never } +--- diff --git a/layouts/shortcodes/docs/languages/instrumentation-intro.md b/content/en/docs/languages/_includes/instrumentation-intro.md similarity index 95% rename from layouts/shortcodes/docs/languages/instrumentation-intro.md rename to content/en/docs/languages/_includes/instrumentation-intro.md index 0632bb37a789..e71dcf60ed3e 100644 --- a/layouts/shortcodes/docs/languages/instrumentation-intro.md +++ b/content/en/docs/languages/_includes/instrumentation-intro.md @@ -1,3 +1,7 @@ +--- +title: # bogus for markdownlint +--- + [Instrumentation](/docs/concepts/instrumentation/) is the act of adding observability code to an app yourself. diff --git a/content/en/docs/languages/cpp/instrumentation.md b/content/en/docs/languages/cpp/instrumentation.md index 829b317558be..9acb62b39696 100644 --- a/content/en/docs/languages/cpp/instrumentation.md +++ b/content/en/docs/languages/cpp/instrumentation.md @@ -9,7 +9,7 @@ cSpell:ignore: decltype labelkv nostd nullptr -{{% docs/languages/instrumentation-intro %}} +{{% include instrumentation-intro.md %}} {{% alert title="Note" color="primary" %}} diff --git a/content/en/docs/languages/erlang/instrumentation.md b/content/en/docs/languages/erlang/instrumentation.md index 7f0c714c0ada..65888f570703 100644 --- a/content/en/docs/languages/erlang/instrumentation.md +++ b/content/en/docs/languages/erlang/instrumentation.md @@ -5,7 +5,7 @@ weight: 30 description: Instrumentation for OpenTelemetry Erlang/Elixir --- -{{% docs/languages/instrumentation-intro %}} +{{% include instrumentation-intro.md %}} ## Setup diff --git a/content/en/docs/languages/go/instrumentation.md b/content/en/docs/languages/go/instrumentation.md index 9a7d8bf7600e..6f1477a1420a 100644 --- a/content/en/docs/languages/go/instrumentation.md +++ b/content/en/docs/languages/go/instrumentation.md @@ -8,7 +8,7 @@ description: Manual instrumentation for OpenTelemetry Go cSpell:ignore: fatalf logr logrus otlplog otlploghttp sdktrace sighup --- -{{% docs/languages/instrumentation-intro %}} +{{% include instrumentation-intro.md %}} ## Setup diff --git a/content/en/docs/languages/js/instrumentation.md b/content/en/docs/languages/js/instrumentation.md index 58d0b6dd1175..35f25c53380f 100644 --- a/content/en/docs/languages/js/instrumentation.md +++ b/content/en/docs/languages/js/instrumentation.md @@ -8,7 +8,7 @@ description: Instrumentation for OpenTelemetry JavaScript cSpell:ignore: dicelib Millis rolldice --- -{{% docs/languages/instrumentation-intro %}} +{{% include instrumentation-intro.md %}} {{% alert title="Note" color="info" %}} diff --git a/content/en/docs/languages/net/instrumentation.md b/content/en/docs/languages/net/instrumentation.md index b1394c13fad4..c271dbbcf1c5 100644 --- a/content/en/docs/languages/net/instrumentation.md +++ b/content/en/docs/languages/net/instrumentation.md @@ -6,7 +6,7 @@ description: Instrumentation for OpenTelemetry .NET cSpell:ignore: dicelib rolldice --- -{{% docs/languages/instrumentation-intro %}} +{{% include instrumentation-intro.md %}} {{% alert title="Note" color="info" %}} diff --git a/content/en/docs/languages/php/instrumentation.md b/content/en/docs/languages/php/instrumentation.md index 7c2b9aa1c90e..3c2113b76e36 100644 --- a/content/en/docs/languages/php/instrumentation.md +++ b/content/en/docs/languages/php/instrumentation.md @@ -8,7 +8,7 @@ cSpell:ignore: guzzlehttp myapp -{{% docs/languages/instrumentation-intro %}} +{{% include instrumentation-intro.md %}} ## Example app preparation {#example-app} diff --git a/content/en/docs/languages/python/instrumentation.md b/content/en/docs/languages/python/instrumentation.md index 0affdb667079..0b03844cf66b 100644 --- a/content/en/docs/languages/python/instrumentation.md +++ b/content/en/docs/languages/python/instrumentation.md @@ -8,7 +8,7 @@ cSpell:ignore: millis ottrace textmap -{{% docs/languages/instrumentation-intro %}} +{{% include instrumentation-intro.md %}} ## Setup diff --git a/content/en/docs/languages/ruby/instrumentation.md b/content/en/docs/languages/ruby/instrumentation.md index b6c835e08341..0ea29394931e 100644 --- a/content/en/docs/languages/ruby/instrumentation.md +++ b/content/en/docs/languages/ruby/instrumentation.md @@ -10,7 +10,7 @@ description: Instrumentation for OpenTelemetry Ruby cSpell:ignore: SIGHUP --- -{{% docs/languages/instrumentation-intro %}} +{{% include instrumentation-intro.md %}} ## Setup diff --git a/content/en/docs/languages/swift/instrumentation.md b/content/en/docs/languages/swift/instrumentation.md index c4ccc47b8e4a..4570b72a660e 100644 --- a/content/en/docs/languages/swift/instrumentation.md +++ b/content/en/docs/languages/swift/instrumentation.md @@ -5,7 +5,7 @@ aliases: [manual] description: Instrumentation for OpenTelemetry Swift --- -{{% docs/languages/instrumentation-intro %}} +{{% include instrumentation-intro.md %}} ## Setup diff --git a/content/es/docs/languages/_includes/_index.md b/content/es/docs/languages/_includes/_index.md new file mode 100644 index 000000000000..bc87ab50b3ab --- /dev/null +++ b/content/es/docs/languages/_includes/_index.md @@ -0,0 +1,6 @@ +--- +title: # bogus for markdownlint +cascade: + build: { list: never, render: never } +default_lang_commit: 7811e854ba3b31c56ce681f1d60cf19e8a5c4358 +--- diff --git a/layouts/shortcodes/es/docs/languages/instrumentation-intro.md b/content/es/docs/languages/_includes/instrumentation-intro.md similarity index 89% rename from layouts/shortcodes/es/docs/languages/instrumentation-intro.md rename to content/es/docs/languages/_includes/instrumentation-intro.md index 74bf8f4eb7ad..3eda40649dde 100644 --- a/layouts/shortcodes/es/docs/languages/instrumentation-intro.md +++ b/content/es/docs/languages/_includes/instrumentation-intro.md @@ -1,3 +1,8 @@ +--- +title: # bogus for markdownlint +default_lang_commit: 7811e854ba3b31c56ce681f1d60cf19e8a5c4358 +--- + [Instrumentar](/docs/concepts/instrumentation/) consiste en añadir el código de observabilidad a una app. diff --git a/content/es/docs/languages/python/instrumentation.md b/content/es/docs/languages/python/instrumentation.md index 84a766ec21f6..37bf53b3d64e 100644 --- a/content/es/docs/languages/python/instrumentation.md +++ b/content/es/docs/languages/python/instrumentation.md @@ -9,7 +9,7 @@ cSpell:ignore: millis ottrace textmap -{{% es/docs/languages/instrumentation-intro %}} +{{% include instrumentation-intro.md %}} ## Configuración diff --git a/content/pt/docs/languages/_includes/_index.md b/content/pt/docs/languages/_includes/_index.md new file mode 100644 index 000000000000..bc87ab50b3ab --- /dev/null +++ b/content/pt/docs/languages/_includes/_index.md @@ -0,0 +1,6 @@ +--- +title: # bogus for markdownlint +cascade: + build: { list: never, render: never } +default_lang_commit: 7811e854ba3b31c56ce681f1d60cf19e8a5c4358 +--- diff --git a/layouts/shortcodes/pt/docs/languages/instrumentation-intro.md b/content/pt/docs/languages/_includes/instrumentation-intro.md similarity index 96% rename from layouts/shortcodes/pt/docs/languages/instrumentation-intro.md rename to content/pt/docs/languages/_includes/instrumentation-intro.md index 5482fd7fca60..4d2c3cefbd2b 100644 --- a/layouts/shortcodes/pt/docs/languages/instrumentation-intro.md +++ b/content/pt/docs/languages/_includes/instrumentation-intro.md @@ -1,6 +1,7 @@ -{{/* +--- +title: # bogus for markdownlint default_lang_commit: 080527543eae90112f01c89342891aabd6258173 -*/ -}} +--- [Instrumentação](/docs/concepts/instrumentation/) é o ato de adicionar código de observabilidade a uma aplicação por conta própria. diff --git a/content/pt/docs/languages/go/instrumentation.md b/content/pt/docs/languages/go/instrumentation.md index e61a98c1fd65..0d89a388b243 100644 --- a/content/pt/docs/languages/go/instrumentation.md +++ b/content/pt/docs/languages/go/instrumentation.md @@ -9,7 +9,7 @@ default_lang_commit: 748555c22f43476291ae0c7974ca4a2577da0472 cSpell:ignore: fatalf logr logrus otlplog otlploghttp sdktrace sighup updown --- -{{% docs/languages/instrumentation-intro %}} +{{% include instrumentation-intro.md %}} ## Configuração {#setup} From 2ed23eb07a336780c5978ab04e2e83affbcfe274 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Mon, 17 Feb 2025 19:38:41 -0500 Subject: [PATCH 2/3] Ensure no page is generated for /xx/_includes --- content/en/_includes/_index.md | 5 +++++ content/en/_includes/page-not-translated-msg.md | 3 +-- content/pt/_includes/_index.md | 6 ++++++ content/pt/_includes/page-not-translated-msg.md | 1 - 4 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 content/en/_includes/_index.md create mode 100644 content/pt/_includes/_index.md diff --git a/content/en/_includes/_index.md b/content/en/_includes/_index.md new file mode 100644 index 000000000000..3ac9b0ca3777 --- /dev/null +++ b/content/en/_includes/_index.md @@ -0,0 +1,5 @@ +--- +title: # bogus for markdownlint +cascade: + build: { list: never, render: never } +--- diff --git a/content/en/_includes/page-not-translated-msg.md b/content/en/_includes/page-not-translated-msg.md index 8616ec44cfbe..0ec483d7f42b 100644 --- a/content/en/_includes/page-not-translated-msg.md +++ b/content/en/_includes/page-not-translated-msg.md @@ -1,6 +1,5 @@ --- -title: # Bogus entry for markdownlint -_build: { list: never, render: never } +title: # bogus entry for markdownlint --- You are diff --git a/content/pt/_includes/_index.md b/content/pt/_includes/_index.md new file mode 100644 index 000000000000..bc87ab50b3ab --- /dev/null +++ b/content/pt/_includes/_index.md @@ -0,0 +1,6 @@ +--- +title: # bogus for markdownlint +cascade: + build: { list: never, render: never } +default_lang_commit: 7811e854ba3b31c56ce681f1d60cf19e8a5c4358 +--- diff --git a/content/pt/_includes/page-not-translated-msg.md b/content/pt/_includes/page-not-translated-msg.md index fc953f26eb45..819f529aa124 100644 --- a/content/pt/_includes/page-not-translated-msg.md +++ b/content/pt/_includes/page-not-translated-msg.md @@ -1,6 +1,5 @@ --- title: # Bogus entry for markdownlint -_build: { list: never, render: never } default_lang_commit: 8d115a9df96c52dbbb3f96c05a843390d90a9800 --- From ed6f3b12258b762bee7e2ba3515638d51c71b130 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Mon, 17 Feb 2025 19:52:43 -0500 Subject: [PATCH 3/3] Update page-not-translated-msg.md --- content/en/_includes/page-not-translated-msg.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/_includes/page-not-translated-msg.md b/content/en/_includes/page-not-translated-msg.md index 0ec483d7f42b..88ebb2ff1057 100644 --- a/content/en/_includes/page-not-translated-msg.md +++ b/content/en/_includes/page-not-translated-msg.md @@ -3,5 +3,5 @@ title: # bogus entry for markdownlint --- You are -viewing the **English version** of this page because it has not yet been +viewing the **English version** of this page because it has not yet been fully translated. Interested in helping out? See [Contributing](/docs/contributing/).