[CI/i18n/pt] Illustrate notes for pt and drop _param shortcode (ope…

…n-telemetry#6078)
vitorvasc · Jan 24, 2025 · 7cb1bd3 · 7cb1bd3
1 parent 149cb6f
commit 7cb1bd3
Show file tree

Hide file tree

Showing 14 changed files with 28 additions and 36 deletions.
diff --git a/content/en/blog/2022/apisix/index.md b/content/en/blog/2022/apisix/index.md
@@ -393,6 +393,6 @@ communicate via the
 
 _A version of this article was [originally posted][] on the Apache APISIX blog._
 
-[^1]: {{% _param notes.docker-compose-v2 %}}
+[^1]: {{% param notes.docker-compose-v2 %}}
 
 [originally posted]: {{% param canonical_url %}}
diff --git a/content/en/blog/2022/debug-otel-with-otel/index.md b/content/en/blog/2022/debug-otel-with-otel/index.md
@@ -247,7 +247,7 @@ COPY default.conf /etc/nginx/conf.d
 COPY opentelemetry_module.conf /etc/nginx/conf.d
 ```
 
-[^1]: {{% _param notes.docker-compose-v2 %}}
+[^1]: {{% param notes.docker-compose-v2 %}}
 
 [learn how to instrument nginx with opentelemetry]: /blog/2022/instrument-nginx/
 [put nginx between two services]:

diff --git a/content/en/blog/2022/demo-announcement/index.md b/content/en/blog/2022/demo-announcement/index.md
@@ -155,4 +155,4 @@ from there.
 - [Demo Requirements](/docs/demo/requirements/)
 - [Get Involved](https://github.com/open-telemetry/opentelemetry-demo#contributing)
 
-[^1]: {{% _param notes.docker-compose-v2 %}}
+[^1]: {{% param notes.docker-compose-v2 %}}
diff --git a/content/en/blog/2022/instrument-apache-httpd-server/index.md b/content/en/blog/2022/instrument-apache-httpd-server/index.md
@@ -254,7 +254,7 @@ writing this blog, support for other architectures is not provided.
 - Now, restart the Apache HTTP Server and OpenTelemetry module should be
   instrumented.
 
-[^1]: {{% _param notes.docker-compose-v2 %}}
+[^1]: {{% param notes.docker-compose-v2 %}}
 
 [docker-compose.yml]:
   https://github.com/open-telemetry/opentelemetry-cpp-contrib/blob/main/instrumentation/otel-webserver-module/docker-compose.yml

diff --git a/content/en/blog/2022/instrument-nginx/index.md b/content/en/blog/2022/instrument-nginx/index.md
@@ -369,7 +369,7 @@ You should now be able to apply what you have learned from this blog post to
 your own installation of NGINX. We would love to hear about your experience! If
 you run into any problems, [create an issue][].
 
-[^1]: {{% _param notes.docker-compose-v2 %}}
+[^1]: {{% param notes.docker-compose-v2 %}}
 
 [create an issue]:
   https://github.com/open-telemetry/opentelemetry-cpp-contrib/issues

diff --git a/content/en/blog/2023/end-user-q-and-a-02.md b/content/en/blog/2023/end-user-q-and-a-02.md
@@ -304,4 +304,4 @@ Be sure to follow OpenTelemetry on
 [Twitter](https://twitter.com/opentelemetry), and share your stories using the
 **#OpenTelemetry** hashtag!
 
-[^1]: {{% _param notes.docker-compose-v2 %}}
+[^1]: {{% param notes.docker-compose-v2 %}}
diff --git a/content/en/docs/contributing/development.md b/content/en/docs/contributing/development.md
@@ -31,7 +31,7 @@ website files.
 ## Local setup
 
 1.  [Fork][] and then [clone][] the website repository at
-    <{{% _param github_repo %}}>.
+    <{{% param github_repo %}}>.
 2.  Go to the repository directory.
 3.  Install or upgrade to the [**active LTS** release][nodejs-rel] of Node.js.
     We recommend using [nvm][] to manage your Node installation. Under Linux,

diff --git a/content/en/docs/demo/docker-deployment.md b/content/en/docs/demo/docker-deployment.md
@@ -145,4 +145,4 @@ After updating the `otelcol-config-extras.yml`, start the demo by running
 `make start`. After a while, you should see the traces flowing into your backend
 as well.
 
-[^1]: {{% _param notes.docker-compose-v2 %}}
+[^1]: {{% param notes.docker-compose-v2 %}}
diff --git a/content/en/docs/demo/tests.md b/content/en/docs/demo/tests.md
@@ -22,4 +22,4 @@ commands for each type of test[^1]:
 To learn more about these tests, see
 [Service Testing](https://github.com/open-telemetry/opentelemetry-demo/tree/main/test).
 
-[^1]: {{% _param notes.docker-compose-v2 %}}
+[^1]: {{% param notes.docker-compose-v2 %}}
diff --git a/content/en/docs/languages/js/_index.md b/content/en/docs/languages/js/_index.md
@@ -12,7 +12,7 @@ cSpell:ignore: Roadmap
 {{% docs/languages/index-intro js /%}}
 
 {{% alert title="Warning" color="warning" %}}
-{{% _param notes.browser-instrumentation %}} {{% /alert %}}
+{{% param notes.browser-instrumentation %}} {{% /alert %}}
 
 ## Version Support
 

diff --git a/content/en/docs/languages/js/getting-started/browser.md b/content/en/docs/languages/js/getting-started/browser.md
@@ -6,7 +6,7 @@ weight: 20
 ---
 
 {{% alert title="Warning" color="warning" %}}
-{{% _param notes.browser-instrumentation %}} {{% /alert %}}
+{{% param notes.browser-instrumentation %}} {{% /alert %}}
 
 While this guide uses the example application presented below, the steps to
 instrument your own application should be similar.

diff --git a/content/en/docs/languages/js/instrumentation.md b/content/en/docs/languages/js/instrumentation.md
@@ -336,7 +336,7 @@ above, you have a `TracerProvider` setup for you already. You can continue with
 #### Browser
 
 {{% alert title="Warning" color="warning" %}}
-{{% _param notes.browser-instrumentation %}} {{% /alert %}}
+{{% param notes.browser-instrumentation %}} {{% /alert %}}
 
 First, ensure you've got the right packages:
 

diff --git a/hugo.yaml b/hugo.yaml
@@ -1,4 +1,4 @@
-# cSpell:ignore docsy goldmark linkify netlify wordmark
+# cSpell:ignore docsy goldmark linkify netlify wordmark noopener
 baseURL: https://opentelemetry.io
 title: OpenTelemetry
 disableKinds: [taxonomy]
@@ -33,6 +33,14 @@ languages:
     languageCode: pt-BR
     params:
       description: Site do Projeto OpenTelemetry
+      notes:
+        browser-instrumentation: |
+          A instrumentação do cliente para o navegador é **experimental** e,
+          em grande parte, **não está especificada**. Caso possua interesse em
+          auxiliar, entre em contato com o [SIG de Instrumentação do
+          Cliente][sig].
+
+          [sig]: https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w
   zh:
     languageName: 中文 (Chinese)
     languageCode: zh-cn
@@ -217,14 +225,19 @@ params:
       sizes: [300, 400, 600, 700]
       type: sans_serif
 
-  notes: # as markdown
+  notes:
+    # Syntax is markdown. This params section is the default for `en` and
+    # fallback for other languages. Add locale specific entries under the
+    # top-level `languages.XX.params` entry for your locale XX.
     docker-compose-v2: |
       `docker-compose` is deprecated. For details, see
       [Migrate to Compose V2](https://docs.docker.com/compose/migrate/).
     browser-instrumentation: |
       Client instrumentation for the browser is **experimental** and mostly **unspecified**.
       If you are interested in helping out, get in touch with the
-      [Client Instrumentation SIG](https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w).
+      [Client Instrumentation SIG][sig].
+
+      [sig]: https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w
 
 security:
   funcs: # cspell:disable-line

diff --git a/layouts/shortcodes/_param.md b/layouts/shortcodes/_param.md