diff --git a/content/en/blog/2022/apisix/index.md b/content/en/blog/2022/apisix/index.md index 579bd2dd1f5e..8be837184052 100644 --- 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 index 4a345339cb98..09e86c139b75 100644 --- 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 index f9bc00cbded3..ec17881652b6 100644 --- 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 index 2dffb1d2b64d..9cd847277c11 100644 --- 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 index 6b9d03eef7a4..8c6560c0b403 100644 --- 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 index 489001d61d43..7c7603c9af97 100644 --- 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 index 74f03654048f..773bdedf16b5 100644 --- 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 index 711966a92971..4a35caceb781 100644 --- 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 index 8af149c60b4d..a987d73949e1 100644 --- 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 index 6c6ee8b61225..2c46e35b4af1 100644 --- 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 index a04a70c22852..3404995e7f0a 100644 --- 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 index a3f1b70ed0ca..b45eb1863a10 100644 --- 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 index 065e3f276d7b..56bff6d5b17f 100644 --- 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 deleted file mode 100644 index 8681ad8b90a1..000000000000 --- a/layouts/shortcodes/_param.md +++ /dev/null @@ -1,21 +0,0 @@ -{{/* - -Like Hugo's `param` shortcode -(https://gohugo.io/content-management/shortcodes/#param) but better, because it -can be used to render markdown simply by invoking it as {{% _param name %}}. - -An enhanced version of: -https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/shortcodes/param.html - -*/ -}} - -{{ $name := (.Get 0) -}} -{{ with $name -}} - {{ with ($.Page.Param .) -}} - {{ . }} - {{- else -}} - {{ errorf "Page or site param %q not found: %s" $name $.Position -}} - {{ end -}} -{{- else -}} - {{ errorf "Missing param key: %s" $.Position -}} -{{ end -}}