Skip to content

Commit f191c90

Browse files
committed
Add and rework alerts
1 parent 0a4c774 commit f191c90

File tree

3 files changed

+19
-6
lines changed

3 files changed

+19
-6
lines changed

content/en/schemas/_index.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ no_list: true
66
body_class: ot-schemas-404
77
#
88
# Note:
9-
# This page can be served from either `/schemas` or `/schemas`.
10-
# This is why the paths to sub-pages `list` and `latest` are absolute below.
9+
# This page can be served from either `/schemas` or `/schemas/`.
10+
# We've ensured that the paths to the `list` and `latest` work in
11+
# both cases by making the path absolute.
1112
#
1213
---
1314

@@ -19,8 +20,13 @@ these:
1920
- More information about [Telemetry Schemas] in general, or [OpenTelemetry
2021
Schema] in particular.
2122

22-
> **Note**: The path `/schemas/` is reserved for the possible future use of
23-
> serving a machine-readable list of schemas.
23+
{{% alert title="<i class=\"fa-solid fa-triangle-exclamation\"></i> Warning" color="warning" %}}
24+
25+
The paths `/schemas` and `/schemas/` reserved for the possible future use of
26+
serving a machine-readable (`application/*`) list of schemas. This page, its
27+
content, and formatting are **non-normative** and **subject to change**.
28+
29+
{{% /alert %}}
2430

2531
[OpenTelemetry Schema]: /docs/specs/otel/schemas/#opentelemetry-schema
2632
[Telemetry Schemas]: /docs/specs/otel/schemas/

content/en/schemas/list.md

+7
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ type: docs
55
body_class: ot-schema-list
66
---
77

8+
{{% alert title="<i class=\"fa-solid fa-triangle-exclamation\"></i> Warning" color="warning" %}}
9+
10+
This page, its content, and formatting are **non-normative** and **subject to
11+
change**. In particular it is not meant for automated processing.
12+
13+
{{% /alert %}}
14+
815
The OpenTelemetry schemas hosted on this site are listed below. To learn more
916
about schemas, see [Telemetry Schemas][].
1017

layouts/index.redirects

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@
4949

5050
/schemas /schemas/? 404!
5151
/schemas/latest /schemas/{{ $latestSchemaFile.Name }}
52-
/schemas/list /schemas/list/ 200
53-
/schemas/* /schemas/? 404 # Report 404 for anything else that's missing
52+
/schemas/list /schemas/list/ 200 # Explicit rule to avoid the next catch all
53+
/schemas/* /schemas/? 404 # Report 404 for anything else that's missing
5454

5555
{{/*
5656
Social-media image redirects. As mentioned in

0 commit comments

Comments
 (0)