Skip to content

Commit 9b61893

Browse files
chalinchalin
authored
Reorg text-sharing shortcodes before we add more (open-telemetry#2854)
1 parent 7ec0b19 commit 9b61893

File tree

17 files changed

+54
-16
lines changed

17 files changed

+54
-16
lines changed

‎content/en/docs/collector/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ currently have mixed [stability levels][].
6363
to ensure that every component has its stability documented. To track the
6464
progress of this effort, see `opentelemetry-collector-contrib` [issue #10116][].
6565

66-
{{% latest_release "collector-releases" /%}}
66+
{{% docs/latest-release collector-releases /%}}
6767

6868
[issue #10116]:
6969
https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/10116

‎content/en/docs/collector/distributions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ the `manifest.yaml` of each distribution.
1212
[distributions]:
1313
https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions
1414

15-
{{% latest_release "collector-releases" /%}}
15+
{{% docs/latest-release collector-releases /%}}
1616

1717
## Custom Distributions
1818

‎content/en/docs/instrumentation/cpp/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: >
66
alt="C++"></img> A language-specific implementation of OpenTelemetry in C++.
77
---
88

9-
{{% lang_instrumentation_index_head cpp /%}}
9+
{{% docs/instrumentation/index-intro cpp /%}}
1010

1111
## Repositories
1212

‎content/en/docs/instrumentation/erlang/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >
88
spelling: cSpell:ignore erlang
99
---
1010

11-
{{% lang_instrumentation_index_head erlang %}}
11+
{{% docs/instrumentation/index-intro erlang %}}
1212

1313
Packages of the API, SDK and OTLP exporter are published to
1414
[`hex.pm`](https://hex.pm) as
@@ -29,4 +29,4 @@ OpenTelemetry Erlang supports Erlang 23+ and Elixir 1.13+.
2929
like [Phoenix](https://www.phoenixframework.org/) and
3030
[Ecto](https://hexdocs.pm/ecto/Ecto.html)
3131

32-
{{% /lang_instrumentation_index_head %}}
32+
{{% /docs/instrumentation/index-intro %}}

‎content/en/docs/instrumentation/java/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ cascade:
99
javaVersion: 1.26.0
1010
---
1111

12-
{{% lang_instrumentation_index_head java /%}}
12+
{{% docs/instrumentation/index-intro java /%}}
1313

1414
### Repositories
1515

‎content/en/docs/instrumentation/js/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ spelling: cSpell:ignore Roadmap
99
weight: 20
1010
---
1111

12-
{{% lang_instrumentation_index_head js /%}}
12+
{{% docs/instrumentation/index-intro js /%}}
1313

1414
## Further Reading
1515

‎content/en/docs/instrumentation/net/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ aliases: [/csharp, /csharp/metrics, /csharp/tracing]
77
weight: 12
88
---
99

10-
{{% lang_instrumentation_index_head dotnet %}}
10+
{{% docs/instrumentation/index-intro dotnet %}}
1111

1212
\* While the OpenTelemetryLoggerProvider (i.e integration with [ILogger][]) is
1313
stable, the [OTLP Log Exporter][] is still non-stable.
1414

15-
{{% /lang_instrumentation_index_head %}}
15+
{{% /docs/instrumentation/index-intro %}}
1616

1717
## Version Support
1818

‎content/en/docs/instrumentation/php/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: >-
66
weight: 21
77
---
88

9-
{{% lang_instrumentation_index_head php /%}}
9+
{{% docs/instrumentation/index-intro php /%}}
1010

1111
## Further Reading
1212

‎content/en/docs/instrumentation/python/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ aliases: [/python, /python/metrics, /python/tracing]
88
weight: 22
99
---
1010

11-
{{% lang_instrumentation_index_head python /%}}
11+
{{% docs/instrumentation/index-intro python /%}}
1212

1313
## Version support
1414

‎content/en/docs/instrumentation/ruby/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ aliases: [/ruby, /ruby/metrics, /ruby/tracing]
77
weight: 24
88
---
99

10-
{{% lang_instrumentation_index_head ruby /%}}
10+
{{% docs/instrumentation/index-intro ruby /%}}
1111

1212
## Who's using OpenTelemetry Ruby?
1313

‎content/en/docs/instrumentation/rust/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ weight: 26
77
spelling: cSpell:ignore datadog dynatrace stackdriver
88
---
99

10-
{{% lang_instrumentation_index_head rust /%}}
10+
{{% docs/instrumentation/index-intro rust /%}}
1111

1212
## Crates
1313

‎content/en/docs/instrumentation/swift/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: >-
77
weight: 28
88
---
99

10-
{{% lang_instrumentation_index_head swift /%}}
10+
{{% docs/instrumentation/index-intro swift /%}}
1111

1212
## Further Reading
1313

‎layouts/shortcodes/latest_release.md ‎layouts/partials/docs/latest-release.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{{ $relUrl := printf "https://github.com/open-telemetry/opentelemetry-%s/releases" (.Get 0) -}}
1+
{{ $relUrl := printf "https://github.com/open-telemetry/opentelemetry-%s/releases" .lang -}}
22

33
For releases, including the [latest release][], see [Releases][].
44
{{- .Inner }}

‎layouts/shortcodes/docs/instrumentation/index-intro.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{{ $lang := .Get 0 -}}
2+
{{ $data := index $.Site.Data.instrumentation.languages $lang }}
3+
{{ $name := $data.name -}}
4+
{{ $tracesStatus := $data.status.traces | humanize -}}
5+
{{ $metricsStatus := $data.status.metrics | humanize -}}
6+
{{ $logsStatus := $data.status.logs | humanize -}}
7+
{{ if in "Stable Experimental" $tracesStatus -}}
8+
{{ $tracesStatus = printf "[%s](/docs/specs/otel/versioning-and-stability/#%s)" $tracesStatus $data.status.traces -}}
9+
{{ end -}}
10+
{{ if in "Stable Experimental" $metricsStatus -}}
11+
{{ $metricsStatus = printf "[%s](/docs/specs/otel/versioning-and-stability/#%s)" $metricsStatus $data.status.metrics -}}
12+
{{ end -}}
13+
{{ if in "Stable Experimental" $logsStatus -}}
14+
{{ $logsStatus = printf "[%s](/docs/specs/otel/versioning-and-stability/#%s)" $logsStatus $data.status.logs -}}
15+
{{ end -}}
16+
17+
This is the OpenTelemetry {{ $name }} documentation. OpenTelemetry is an
18+
observability framework -- an API, SDK, and tools that are designed to aid in
19+
the generation and collection of application telemetry data such as metrics,
20+
logs, and traces. This documentation is designed to help you understand how to
21+
get started using OpenTelemetry {{ $name }}.
22+
23+
## Status and Releases
24+
25+
The current status of the major functional components for OpenTelemetry {{ $name }} is
26+
as follows:
27+
28+
| Traces | Metrics | Logs |
29+
| -------- | ------- | ------- |
30+
| {{ $tracesStatus }} | {{ $metricsStatus }} | {{ $logsStatus }} |
31+
32+
{{ partial "docs/latest-release.md" (dict "lang" $lang "Inner" .Inner) -}}

‎layouts/shortcodes/docs/latest-release.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{{ partial "docs/latest-release.md" (dict "lang" (.Get 0) "Inner" .Inner) -}}

‎layouts/shortcodes/lang_instrumentation_index_head.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
{{/*
2+
TODO: keep this duplicate of `layouts/shortcodes/docs/instrumentation/index-intro.md`
3+
only until the Go docs are updated.
4+
*/ -}}
5+
16
{{ $data := index $.Site.Data.instrumentation.languages (.Get 0) }}
27
{{ $name := $data.name }}
38
{{ $relUrl := printf "https://github.com/open-telemetry/opentelemetry-%s/releases" (.Get 0) -}}

‎templates/language-docs/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Important status or maturity information should go into a table here, as below.
1818
| ------- | ------- |
1919
| Beta | Alpha |
2020

21-
{{% latest_release "language-name" /%}}
21+
{{% docs/latest-release "language-name" /%}}
2222

2323
## Further Reading
2424

0 commit comments

Comments
 (0)