Skip to content

Commit

Permalink
[apm docs consolidation] 8.3: Delete moved files, update README (#12406)
Browse files Browse the repository at this point in the history
  • Loading branch information
colleenmcginnis committed Jan 17, 2024
1 parent 6cf7f55 commit a6c6388
Show file tree
Hide file tree
Showing 238 changed files with 22 additions and 44,770 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For questions and feature requests, visit the [discussion forum](https://discuss

## Getting Started

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

## APM Server Development

Expand Down Expand Up @@ -144,4 +144,13 @@ When building images for testing pre-release versions, we recommend setting `SNA

## Documentation

[Documentation](https://www.elastic.co/guide/en/apm/server/current/index.html) for the APM Server can be found in the `docs` folder.
Documentation for the APM Server can be found in the [APM guide](https://www.elastic.co/guide/en/apm/guide/8.5/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.5/docs/en/apm-server).

However, the following content lives in this repo:

* The **changelog** page listing all release notes is in [`CHANGELOG.asciidoc`](/CHANGELOG.asciidoc).
* Each minor version's **release notes** are documented in individual files in the [`changelogs/`](/changelogs/) directory.
* A list of all **breaking changes** are documented in [`changelogs/all-breaking-changes.asciidoc`](/changelogs/all-breaking-changes.asciidoc).
* **Sample data sets** that are injected into the docs are in the [`docs/data/`](/docs/data/) directory.
* **Specifications** that are injected into the docs are in the [`docs/spec/`](/docs/spec/) directory.

2 changes: 1 addition & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@

## When compatibility between Agents & Server changes

* Update the [agent/server compatibility matrix](https://github.com/elastic/apm-server/blob/main/docs/guide/agent-server-compatibility.asciidoc).
* 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.

## Templates

Expand Down
10 changes: 10 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
> [!IMPORTANT]
> Most documentation source files have moved to the [elastic/observability-docs](https://github.com/elastic/observability-docs) repo ([`docs/en/apm-server/`](https://github.com/elastic/observability-docs/tree/8.5/docs/en/apm-server)).
>
> However, the following content still lives in this repo:
>
> * The **changelog** page listing all release notes is in [`CHANGELOG.asciidoc`](/CHANGELOG.asciidoc).
> * Each minor version's **release notes** are documented in individual files in the [`changelogs/`](/changelogs/) directory.
> * A list of all **breaking changes** are documented in [`changelogs/all-breaking-changes.asciidoc`](/changelogs/all-breaking-changes.asciidoc).
> * **Sample data sets** that are injected into the docs are in the [`docs/data/`](/docs/data/) directory.
> * **Specifications** that are injected into the docs are in the [`docs/spec/`](/docs/spec/) directory.
46 changes: 0 additions & 46 deletions docs/agent-server-compatibility.asciidoc

This file was deleted.

91 changes: 0 additions & 91 deletions docs/api-config.asciidoc

This file was deleted.

16 changes: 0 additions & 16 deletions docs/api-error.asciidoc

This file was deleted.

9 changes: 0 additions & 9 deletions docs/api-event-example.asciidoc

This file was deleted.

123 changes: 0 additions & 123 deletions docs/api-events.asciidoc

This file was deleted.

39 changes: 0 additions & 39 deletions docs/api-info.asciidoc

This file was deleted.

Loading

0 comments on commit a6c6388

Please sign in to comment.