Skip to content

Commit 77b208a

Browse files
authoredJan 8, 2024
[apm docs consolidation] 8.10: Delete moved files, update README (#12356)
* delete files, update README * update README
1 parent 851f3c2 commit 77b208a

File tree

185 files changed

+25
-17795
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

185 files changed

+25
-17795
lines changed
 

‎README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ For questions and feature requests, visit the [discussion forum](https://discuss
1111

1212
## Getting Started
1313

14-
To get started with APM, see our [Quick start guide](https://www.elastic.co/guide/en/apm/get-started/current/install-and-run.html).
14+
To get started with APM, see our [Quick start guide](https://www.elastic.co/guide/en/apm/guide/current/apm-quick-start.html).
1515

1616
## APM Server Development
1717

@@ -154,5 +154,13 @@ Building pre-release images can be done by running `make package-docker-snapshot
154154

155155
## Documentation
156156

157-
[Documentation](https://www.elastic.co/guide/en/apm/server/current/index.html)
158-
for the APM Server can be found in the `docs` and `dev_docs` folders.
157+
Documentation for the APM Server can be found in the [APM guide](https://www.elastic.co/guide/en/apm/guide/8.10/index.html). Most documentation files live in the [elastic/observability-docs](https://github.com/elastic/observability-docs) repo's [`docs/en/apm-server/` directory](https://github.com/elastic/observability-docs/tree/8.10/docs/en/apm-server).
158+
159+
However, the following content lives in this repo:
160+
161+
* The **changelog** page listing all release notes is in [`CHANGELOG.asciidoc`](/CHANGELOG.asciidoc).
162+
* Each minor version's **release notes** are documented in individual files in the [`changelogs/`](/changelogs/) directory.
163+
* A list of all **breaking changes** are documented in [`changelogs/all-breaking-changes.asciidoc`](/changelogs/all-breaking-changes.asciidoc).
164+
* **Sample data sets** that are injected into the docs are in the [`docs/data/`](/docs/data/) directory.
165+
* **Specifications** that are injected into the docs are in the [`docs/spec/`](/docs/spec/) directory.
166+

‎dev_docs/RELEASES.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ For patch releases, only the version on the existing major and minor version bra
99

1010
## Feature Freeze
1111

12-
* For patch releases, ensure all relevant backport PRs are merged.
12+
* For patch releases, ensure all relevant backport PRs are merged.
1313
We use backport labels on PRs and automation to ensure labels are set.
1414

1515
* Update Changelog
@@ -30,9 +30,9 @@ For patch releases, only the version on the existing major and minor version bra
3030
Update versions and ensure that the `BEATS_VERSION` in the Makefile is updated,
3131
e.g. [#2803](https://github.com/elastic/apm-server/pull/2803/files).
3232
Trigger a new beats update, once the beats branch is also created.
33-
Remove the [changelogs/head.asciidoc](https://github.com/elastic/apm-server/blob/main/changelogs/head.asciidoc) file from the release branch.
33+
Remove the [changelogs/head.asciidoc](https://github.com/elastic/apm-server/blob/main/changelogs/head.asciidoc) file from the release branch.
3434

35-
* Main branch:
35+
* Main branch:
3636
Update [.mergify.yml](https://github.com/elastic/apm-server/blob/main/.mergify.yml) with a new backport rule for the next version,
3737
and update versions to next minor version, e.g. [#2804](https://github.com/elastic/apm-server/pull/2804).
3838

@@ -86,7 +86,7 @@ For patch releases, only the version on the existing major and minor version bra
8686

8787
## When compatibility between Agents & Server changes
8888

89-
* Update the [agent/server compatibility matrix](https://github.com/elastic/apm-server/blob/main/docs/guide/agent-server-compatibility.asciidoc).
89+
* Update the [agent/server compatibility matrix](https://github.com/elastic/observability-docs/blob/main/docs/en/observability/apm/agent-server-compatibility.asciidoc) in the elastic/observability repo.
9090

9191
## Templates
9292

0 commit comments

Comments
 (0)