Skip to content

Commit 2b92a0b

Browse files
chalinchalin
authored
[editorial] Fix links and switch to table markdown syntax (#4508)
- Converts two new HTML tables into the equivalent Markdown syntax, otherwise the link references inside the tables don't get correctly processed by Hugo - Fixes links that break when the spec is published to the website. **Reminder**: don't link to spec page titles since those link targets don't exist in the published website HTML pages. /cc @carlosalberto @jsuereth - once this get's merged, I'd like to test the OTel.io build again before you issue a release. So please let me know.
1 parent 0210e25 commit 2b92a0b

File tree

3 files changed

+10
-92
lines changed

3 files changed

+10
-92
lines changed

‎specification/entities/data-model.md‎

Lines changed: 5 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -36,63 +36,11 @@ also runs on a host, so we say that the `process` entity is related to the
3636
The data model below defines a logical model for an entity (irrespective of the
3737
physical format and encoding of how entity data is recorded).
3838

39-
<table>
40-
<tr>
41-
<td><strong>Field</strong>
42-
</td>
43-
<td><strong>Type</strong>
44-
</td>
45-
<td><strong>Description</strong>
46-
</td>
47-
</tr>
48-
<tr>
49-
<td>Type
50-
</td>
51-
<td>string
52-
</td>
53-
<td>Defines the type of the entity. MUST not change during the
54-
lifetime of the entity. For example: "service" or "host". This field is
55-
required and MUST not be empty for valid entities.
56-
</td>
57-
</tr>
58-
<tr>
59-
<td>Id
60-
</td>
61-
<td>map&lt;string, standard attribute value&gt;
62-
</td>
63-
<td>Attributes that identify the entity.
64-
<p>
65-
MUST not change during the lifetime of the entity. The Id must contain
66-
at least one attribute.
67-
<p>
68-
Follows OpenTelemetry <a
69-
href="../../specification/common/README.md#standard-attribute">Standard
70-
attribute definition</a>. SHOULD follow OpenTelemetry <a
71-
href="https://github.com/open-telemetry/semantic-conventions">semantic
72-
conventions</a> for attributes.
73-
</td>
74-
</tr>
75-
<tr>
76-
<td>Description
77-
</td>
78-
<td>map&lt;string, any&gt;
79-
</td>
80-
<td>Descriptive (non-identifying) attributes of the entity.
81-
<p>
82-
MAY change over the lifetime of the entity. MAY be empty. These
83-
attributes are not part of entity's identity.
84-
<p>
85-
Follows <a
86-
href="../../specification/logs/data-model.md#type-any">any</a>
87-
value definition in the OpenTelemetry spec. Arbitrary deep nesting of values
88-
for arrays and maps is allowed.
89-
<p>
90-
SHOULD follow OpenTelemetry <a
91-
href="https://github.com/open-telemetry/semantic-conventions">semantic
92-
conventions</a> for attributes.
93-
</td>
94-
</tr>
95-
</table>
39+
| Field | Type | Description |
40+
|--------------|----------------------------------------|-----------------|
41+
| Type | string | Defines the type of the entity. MUST not change during the lifetime of the entity. For example: "service" or "host". This field is required and MUST not be empty for valid entities. |
42+
| Id | map<string, standard attribute value> | Attributes that identify the entity.<p>MUST not change during the lifetime of the entity. The Id must contain at least one attribute.<p>Follows OpenTelemetry [Standard attribute definition](../common/README.md#standard-attribute). SHOULD follow OpenTelemetry [semantic conventions](https://github.com/open-telemetry/semantic-conventions) for attributes. |
43+
| Description | map<string, any> | Descriptive (non-identifying) attributes of the entity.<p>MAY change over the lifetime of the entity. MAY be empty. These attributes are not part of entity's identity.<p>Follows [any](../logs/data-model.md#type-any) value definition in the OpenTelemetry spec. Arbitrary deep nesting of values for arrays and maps is allowed.<p>SHOULD follow OpenTelemetry [semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/README.md) for attributes. |
9644

9745
## Minimally Sufficient Identity
9846

‎specification/resource/data-model.md‎

Lines changed: 4 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -27,40 +27,10 @@ or more attributes not associated with any entity.
2727

2828
The data model below defines a logical model for an Resource (irrespective of the physical format and encoding of how resource data is recorded).
2929

30-
<table>
31-
<tr>
32-
<td><strong>Field</strong>
33-
</td>
34-
<td><strong>Type</strong>
35-
</td>
36-
<td><strong>Description</strong>
37-
</td>
38-
</tr>
39-
<tr>
40-
<td>Entities
41-
</td>
42-
<td>set&lt;Entity&gt;
43-
</td>
44-
<td>Defines the set of Entities associated with this resource.
45-
<p><a href="../entities/data-model.md#entity-data-model">Entity is defined
46-
here</a>
47-
</td>
48-
</tr>
49-
<tr>
50-
<td>Attributes
51-
</td>
52-
<td>map&lt;string, standard attribute value&gt;
53-
</td>
54-
<td>Additional Attributes that identify the resource.
55-
<p>
56-
MUST not change during the lifetime of the resource.
57-
<p>
58-
Follows OpenTelemetry <a
59-
href="../../specification/common/README.md#standard-attribute">Standard
60-
attribute definition</a>.
61-
</td>
62-
</tr>
63-
</table>
30+
| Field | Type | Description |
31+
|------------|----------|-----------------|
32+
| Entities | set\<Entity\> | Defines the set of Entities associated with this resource.<p>[Entity is defined here](../entities/data-model.md) |
33+
| Attributes | map\<string, standard attribute value\> | Additional Attributes that identify the resource.<p>MUST not change during the lifetime of the resource.<p>Follows OpenTelemetry [Standard attribute definition](../common/README.md#standard-attribute). |
6434

6535
## Identity
6636

‎specification/trace/tracestate-probability-sampling.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ This section defines the behavior for these two categories of samplers.
131131

132132
See [SDK requirements for trace randomness](./sdk.md#sampling-requirements), which covers potentially inserting explicit trace randomness using the OpenTelemetry TraceState `rv` sub-key.
133133

134-
A head Sampler is responsible for computing the `th` value in a new span's [OpenTelemetry TraceState](./tracestate-handling.md#tracestate-handling). The main inputs to that computation include the parent context's TraceState and the TraceID.
134+
A head Sampler is responsible for computing the `th` value in a new span's [OpenTelemetry TraceState](./tracestate-handling.md). The main inputs to that computation include the parent context's TraceState and the TraceID.
135135

136136
When a span is sampled by in accordance with this specification, the output TraceState SHOULD be set to convey probability sampling:
137137

0 commit comments

Comments
 (0)