Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add release notes, API, and auth docs to APM Guide #6427

Merged
merged 7 commits into from
Oct 27, 2021

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Oct 26, 2021

Summary

This PR adds the following content to the APM Guide:

  • Moves release notes from the deprecated APM Server Reference to the APM guide.
  • Updates the Secure communication with APM agents docs for EA. In a later PR, we may want to make this task-oriented and move it into the how-to bucket.
  • Adds the API documentation with minimal changes

Related issues

For elastic/observability-docs#1073.

@bmorelli25 bmorelli25 added docs v7.16.0 backport-7.16 Automated backport with mergify to the 7.16 branch labels Oct 26, 2021
@bmorelli25 bmorelli25 self-assigned this Oct 26, 2021
@apmmachine
Copy link
Contributor

apmmachine commented Oct 26, 2021

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2021-10-27T19:16:51.078+0000

  • Duration: 42 min 40 sec

  • Commit: b9a8578

Test stats 🧪

Test Results
Failed 0
Passed 6309
Skipped 18
Total 6327

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /hey-apm : Run the hey-apm benchmark.

  • /package : Generate and publish the docker images.

@bmorelli25 bmorelli25 requested a review from a team October 26, 2021 23:54
@bmorelli25 bmorelli25 marked this pull request as ready for review October 26, 2021 23:54
@bmorelli25 bmorelli25 changed the title docs: add more content to APM guide docs: add release notes, API, and auth docs to APM Guide Oct 26, 2021
Copy link
Member

@axw axw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I haven't reviewed the content of the API docs, as I assume it's basically just moved. Just happened across one small issue.

docs/secure-agent-communication.asciidoc Show resolved Hide resolved
docs/api-info.asciidoc Outdated Show resolved Hide resolved
@axw
Copy link
Member

axw commented Oct 27, 2021

@bmorelli25 I realised today that we haven't formally deprecated source map upload via apm-server, which we'll be removing in 8.0. I've just created #6433 for that. There's a bit of overlap with this PR and probably others you're working, so just letting you know.

@bmorelli25 bmorelli25 added the backport-8.0 Automated backport with mergify label Oct 27, 2021
@bmorelli25 bmorelli25 merged commit e271958 into elastic:master Oct 27, 2021
@bmorelli25 bmorelli25 deleted the add-api-etc-docs branch October 27, 2021 20:33
mergify bot pushed a commit that referenced this pull request Oct 27, 2021
mergify bot pushed a commit that referenced this pull request Oct 27, 2021
(cherry picked from commit e271958)

# Conflicts:
#	changelogs/8.0.asciidoc
#	changelogs/head.asciidoc
bmorelli25 added a commit that referenced this pull request Oct 27, 2021
(cherry picked from commit e271958)

Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
bmorelli25 added a commit that referenced this pull request Oct 27, 2021
…port #6427) (#6441)

Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-7.16 Automated backport with mergify to the 7.16 branch backport-8.0 Automated backport with mergify docs v7.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants