Skip to content

Commit 38eaca9

Browse files
authored
Fix anchors and instructions (#698)
1 parent 7d10737 commit 38eaca9

File tree

4 files changed

+21
-49
lines changed

4 files changed

+21
-49
lines changed

docs/release-notes/breaking-changes.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,11 @@ products:
1515

1616
Breaking changes can impact your applications, potentially disrupting normal operations and their monitoring. Before you upgrade, carefully review the Elastic Distribution of OpenTelemetry Java breaking changes and take the necessary steps to mitigate any issues.
1717

18-
% ## Next version [edot-X.X.X-breaking-changes]
18+
% ## Next version [edot-java-X.X.X-breaking-changes]
1919

2020
% Use the following template to add entries to this document.
2121

2222
% TEMPLATE START
23-
% $$$kibana-PR_NUMBER$$$
2423
% ::::{dropdown} Title of breaking change
2524
% Description of the breaking change.
2625
% **Impact**<br> Impact of the breaking change.
@@ -29,17 +28,4 @@ Breaking changes can impact your applications, potentially disrupting normal ope
2928
% ::::
3029
% TEMPLATE END
3130

32-
% 1. Copy and edit the template in the right area section of this file. Most recent entries should be at the top of the section.
33-
% 2. Edit the anchor ID ($$$kibana-PR_NUMBER$$$) of the template with the correct PR number to give the entry a unique URL.
34-
% 3. Don't hardcode the link to the new entry. Instead, make it available through the doc link service files:
35-
% - {kib-repo}blob/{branch}/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
36-
% - {kib-repo}blob/{branch}/src/platform/packages/shared/kbn-doc-links/src/types.ts
37-
%
38-
% The entry in the main links file should look like this:
39-
%
40-
% id: `${KIBANA_DOCS}breaking-changes.html#kibana-PR_NUMBER`
41-
%
42-
% 4. You can then call the link from any Kibana code. For example: `href: docLinks.links.upgradeAssistant.id`
43-
% Check https://docs.elastic.dev/docs/kibana-doc-links (internal) for more details about the Doc links service.
44-
45-
No breaking changes currently.
31+
No breaking changes.

docs/release-notes/deprecations.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,11 @@ Over time, certain Elastic functionality becomes outdated and is replaced or rem
1717

1818
Review the deprecated functionality for Elastic Distribution of OpenTelemetry Java. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade. To learn how to upgrade, check out [Upgrade](docs-content://deploy-manage/upgrade.md).
1919

20-
% ## Next version [edot-X.X.X-deprecations]
20+
% ## Next version [edot-java-X.X.X-deprecations]
2121

2222
% Use the following template to add entries to this document.
2323

2424
% TEMPLATE START
25-
% $$$kibana-PR_NUMBER$$$
2625
% ::::{dropdown} Deprecation title
2726
% Description of the deprecation.
2827
% **Impact**<br> Impact of the deprecation.
@@ -31,17 +30,4 @@ Review the deprecated functionality for Elastic Distribution of OpenTelemetry Ja
3130
% ::::
3231
% TEMPLATE END
3332

34-
% 1. Copy and edit the template in the right area section of this file. Most recent entries should be at the top of the section.
35-
% 2. Edit the anchor ID ($$$kibana-PR_NUMBER$$$) of the template with the correct PR number to give the entry a unique URL.
36-
% 3. Don't hardcode the link to the new entry. Instead, make it available through the doc link service files:
37-
% - {kib-repo}blob/{branch}/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
38-
% - {kib-repo}blob/{branch}/src/platform/packages/shared/kbn-doc-links/src/types.ts
39-
%
40-
% The entry in the main links file should look like this:
41-
%
42-
% id: `${KIBANA_DOCS}deprecations.html#kibana-PR_NUMBER`
43-
%
44-
% 4. You can then call the link from any Kibana code. For example: `href: docLinks.links.upgradeAssistant.id`
45-
% Check https://docs.elastic.dev/docs/kibana-doc-links (internal) for more details about the Doc links service.
46-
47-
No deprecations currently.
33+
No deprecations.

docs/release-notes/index.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@ To check for security updates, go to [Security announcements for the Elastic sta
1919

2020
% Release notes include only features, enhancements, and fixes. Add breaking changes, deprecations, and known issues to the applicable release notes sections.
2121

22-
% ## version.next [kibana-X.X.X-release-notes]
22+
% ## version.next [edot-java-X.X.X-release-notes]
2323

24-
% ### Features and enhancements [kibana-X.X.X-features-enhancements]
24+
% ### Features and enhancements [edot-java-X.X.X-features-enhancements]
2525
% *
2626

27-
% ### Fixes [kibana-X.X.X-fixes]
27+
% ### Fixes [edot-java-X.X.X-fixes]
2828
% *
2929

30-
## 1.4.1
30+
## 1.4.1 [edot-java-1.4.1-release-notes]
3131

32-
### Fixes
32+
### Fixes [edot-java-1.4.1-fixes]
3333

3434
* Fixed `otel.exporter.otlp.metrics.temporality.preference` config option having no effect.
3535

@@ -40,9 +40,9 @@ This release is based on the following upstream versions:
4040
* opentelemetry-semconv: [1.32.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.32.0).
4141
* opentelemetry-java-contrib: [1.45.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.45.0).
4242

43-
## 1.4.0
43+
## 1.4.0 [edot-java-1.4.0-release-notes]
4444

45-
### Features and enhancements
45+
### Features and enhancements [edot-java-1.4.0-features-enhancements]
4646

4747
* Switched the default of `otel.exporter.otlp.metrics.temporality.preference` from `CUMULATIVE` to `DELTA` to improve dashboarding experience with Kibana. If you want to restore the previous behaviour, you can manually override `otel.exporter.otlp.metrics.temporality.preference` to `CUMULATIVE` via JVM-properties or environment variables.
4848
* Set elastic-specific User-Agent header for OTLP exporters.
@@ -56,9 +56,9 @@ This release is based on the following upstream versions:
5656
* opentelemetry-semconv: [1.32.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.32.0).
5757
* opentelemetry-java-contrib: [1.45.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.45.0).
5858

59-
## 1.3.0
59+
## 1.3.0 [edot-java-1.3.0-release-notes]
6060

61-
### Features and enhancements
61+
### Features and enhancements [edot-java-1.3.0-features-enhancements]
6262

6363
* Added support for OpenAI client 0.14 to 0.31.
6464
* Added support for OpenAI developer messages and raise minimum supported version to 0.8.0.
@@ -70,9 +70,9 @@ This release is based on the following upstream versions:
7070
* opentelemetry-semconv: [1.30.0-rc.1](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.30.0-rc.1).
7171
* opentelemetry-java-contrib: [1.44.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.44.0).
7272

73-
## 1.2.1
73+
## 1.2.1 [edot-java-1.2.1-release-notes]
7474

75-
### Features and enhancements
75+
### Features and enhancements [edot-java-1.2.1-features-enhancements]
7676

7777
* Added support for OpenAI client 0.13.0.
7878

@@ -83,9 +83,9 @@ This release is based on the following upstream versions:
8383
* opentelemetry-semconv: [1.29.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.29.0).
8484
* opentelemetry-java-contrib: [1.42.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.42.0).
8585

86-
## 1.2.0
86+
## 1.2.0 [edot-java-1.2.0-release-notes]
8787

88-
### Features and enhancements
88+
### Features and enhancements [edot-java-1.2.0-features-enhancements]
8989

9090
* Added dynamically disabled instrumentation capability.
9191
* Added disable all instrumentations option.
@@ -99,9 +99,9 @@ This release is based on the following upstream versions:
9999
* opentelemetry-semconv: [1.29.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.29.0).
100100
* opentelemetry-java-contrib: [1.42.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.42.0).
101101

102-
## 1.1.0
102+
## 1.1.0 [edot-java-1.1.0-release-notes]
103103

104-
### Fixes
104+
### Fixes [edot-java-1.1.0-fixes]
105105

106106
* Fixed missing transitive dependencies when using universal profiling integration standalone.
107107

@@ -112,6 +112,6 @@ This release is based on the following upstream versions:
112112
* opentelemetry-semconv: [1.28.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.28.0).
113113
* opentelemetry-java-contrib: [1.40.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.40.0).
114114

115-
## 1.0.0
115+
## 1.0.0 [edot-java-1.0.0-release-notes]
116116

117117
General Availability release.

docs/release-notes/known-issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ products:
1313

1414
# Elastic Distribution of OpenTelemetry Java known issues
1515

16-
No known issues currently.
16+
No known issues.

0 commit comments

Comments
 (0)