Skip to content

Commit

Permalink
[8.3] [apm docs consolidation] Clean up (backport #3476) (#3482)
Browse files Browse the repository at this point in the history
* [apm docs consolidation] Clean up  (#3476)

* use tagged regions for release notes

* rename apm-breaking, point to apm-server

* remove data and spec directories, point to apm-server

(cherry picked from commit d4309b5)

# Conflicts:
#	docs/en/apm-server/apm-breaking.asciidoc
#	docs/en/apm-server/data-model.asciidoc
#	docs/en/apm-server/data/elasticsearch/generated/errors.json
#	docs/en/apm-server/data/elasticsearch/generated/spans.json
#	docs/en/apm-server/data/elasticsearch/generated/transactions.json
#	docs/en/apm-server/data/elasticsearch/metricset.json
#	docs/en/apm-server/release-notes.asciidoc
#	docs/en/apm-server/spec/rumv3/error.json
#	docs/en/apm-server/spec/rumv3/span.json
#	docs/en/apm-server/spec/rumv3/transaction.json
#	docs/en/apm-server/spec/v2/error.json
#	docs/en/apm-server/spec/v2/metadata.json
#	docs/en/apm-server/spec/v2/metricset.json
#	docs/en/apm-server/spec/v2/span.json
#	docs/en/apm-server/spec/v2/transaction.json

* fix conflicts

* fix build errors

* update reference to bundle.js.map file

---------

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
  • Loading branch information
mergify[bot] and colleenmcginnis committed Jan 2, 2024
1 parent 785abfa commit 3839511
Show file tree
Hide file tree
Showing 26 changed files with 46 additions and 512 deletions.
2 changes: 1 addition & 1 deletion docs/en/apm-server/api-error.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ APM Server uses JSON Schema to validate requests. The specification for errors i

[source,json]
----
include::./spec/v2/error.json[]
include::{apm-server-root}/docs/spec/v2/error.json[]
----
2 changes: 1 addition & 1 deletion docs/en/apm-server/api-event-example.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ A request body example containing one event for all currently supported event ty

[source,json]
----
include::./data/intake-api/generated/events.ndjson[]
include::{apm-server-root}/docs/data/intake-api/generated/events.ndjson[]
----
2 changes: 1 addition & 1 deletion docs/en/apm-server/api-metadata.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ APM Server uses JSON Schema to validate requests. The specification for metadata

[source,json]
----
include::./spec/v2/metadata.json[]
include::{apm-server-root}/docs/spec/v2/metadata.json[]
----
2 changes: 1 addition & 1 deletion docs/en/apm-server/api-metricset.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ APM Server uses JSON Schema to validate requests. The specification for metrics

[source,json]
----
include::./spec/v2/metricset.json[]
include::{apm-server-root}/docs/spec/v2/metricset.json[]
----
2 changes: 1 addition & 1 deletion docs/en/apm-server/api-span.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ APM Server uses JSON Schema to validate requests. The specification for spans is

[source,json]
----
include::./spec/v2/span.json[]
include::{apm-server-root}/docs/spec/v2/span.json[]
----
2 changes: 1 addition & 1 deletion docs/en/apm-server/api-transaction.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ APM Server uses JSON Schema to validate requests. The specification for transact

[source,json]
----
include::./spec/v2/transaction.json[]
include::{apm-server-root}/docs/spec/v2/transaction.json[]
----
8 changes: 4 additions & 4 deletions docs/en/apm-server/data-model.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ This example shows what span documents can look like when indexed in {es}.
====
[source,json]
----
include::./data/elasticsearch/generated/spans.json[]
include::{apm-server-root}/docs/data/elasticsearch/generated/spans.json[]
----
====

Expand Down Expand Up @@ -159,7 +159,7 @@ This example shows what transaction documents can look like when indexed in {es}
====
[source,json]
----
include::./data/elasticsearch/generated/transactions.json[]
include::{apm-server-root}/docs/data/elasticsearch/generated/transactions.json[]
----
====

Expand Down Expand Up @@ -212,7 +212,7 @@ This example shows what error documents can look like when indexed in {es}.
====
[source,json]
----
include::./data/elasticsearch/generated/errors.json[]
include::{apm-server-root}/docs/data/elasticsearch/generated/errors.json[]
----
====

Expand Down Expand Up @@ -385,7 +385,7 @@ These fields make it possible to search and aggregate across various dimensions,
[source,json]
----
include::./data/elasticsearch/metricset.json[]
include::{apm-server-root}/docs/data/elasticsearch/metricset.json[]
----
====

Expand Down
112 changes: 0 additions & 112 deletions docs/en/apm-server/data/elasticsearch/generated/rum_v3_errors.json

This file was deleted.

This file was deleted.

5 changes: 0 additions & 5 deletions docs/en/apm-server/data/intake-api/generated/events.ndjson

This file was deleted.

Loading

0 comments on commit 3839511

Please sign in to comment.