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 "deprecating soon" notices #6708

Merged
merged 11 commits into from
Nov 29, 2021

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Nov 24, 2021

Summary

The main purpose of this PR was:

  • Adds deprecation notices to all "Legacy" documentation pages and links to relevant APM integration/Fleet docs where applicable (except those pages that will be moved in docs: Add upgrading documentation #6709, like upgrading, breaking changes, and agent/server compact)

Along the way (I had to look at every single file in the legacy docs) I noticed a few things:

  • Fixed a few small layout bugs
  • Moves legacy overview content from their own pages to the top page of each legacy bucket (1) (2)
  • Updates the arch diagram and component documentation (link) per docs: APM integration documentation #6287 (comment)
  • Removed original APM integration docs from APM Server Reference (these)

Thought process

As you're all well aware, there's now a lot of duplicated content in the APM documentation. This duplicated content exists in three forms:

  1. Content where there's a major difference between the APM integration docs and APM Server legacy docs. Example: Quick start guides.
  2. Content where there are minor differences between the APM integration docs and APM Server legacy docs. Example: API docs.
  3. Content where there is no difference between the APM integration docs and APM Server legacy docs. Example: Transaction sampling docs.

Why duplicate everything? The idea was to have two distinct guides—one for APM integration users, and one for legacy APM Server users. The only way this is possible is by ensuring each section has all of its own docs, even if that means duplicating some content verbatim. But this leads to a new problem—what happens when users google their way into the wrong docs? Before, it wasn't immediately clear which docs you were looking at. So, in this PR, I've added a note to the top of every page in the legacy APM Overview and the legacy APM Server Reference indicating that the method of running/installing/configuring APM Server will be deprecated in a future release. In addition, if there's related documentation for the APM integration, I've linked to it.

(soon to be) Deprecated words

THE 🥩 🥩 🥩 🥩 🥩 🥩 OF THIS PR IS HERE

I originally wanted to get rid of the word legacy, but I actually think it works well in this context. Open to any feedback and all ideas—I'm curious to read your thoughts!

// For installation, get started, and setup docs
:deprecation-notice-installation: This method of installing APM Server will be deprecated and removed in a future release. Please consider getting started with the <<apm-quick-start,Elastic APM integration>> instead.
// Generic "running" message
// Usually followed by a link to the corresponding APM integration docs
// Link to upgrade docs will be added in #6709
:deprecation-notice-data: This documentation refers to the standalone (legacy) method of running APM Server. This method of running APM Server will be deprecated and removed in a future release. Please consider upgrading to the Elastic APM integration.
// For monitoring docs
// Link to upgrade docs will be added in #6709
:deprecation-notice-monitor: This documentation refers to monitoring the standalone (legacy) APM Server. This method of running APM Server will be deprecated and removed in a future release. Please consider upgrading to {fleet} and the APM integration.
// For configuration docs
// Link to upgrade docs will be added in #6709
:deprecation-notice-config: This documentation refers to configuring the standalone (legacy) APM Server. This method of running APM Server will be deprecated and removed in a future release. Please consider upgrading to {fleet} and the APM integration.
// For API docs
// Link to upgrade docs will be added in #6709
:deprecation-notice-api: This documentation refers to the API of the standalone (legacy) APM Server. This method of running APM Server will be deprecated and removed in a future release. Please consider upgrading to {fleet} and the APM integration.

Preview

Click me

@bmorelli25 bmorelli25 added backport-7.16 Automated backport with mergify to the 7.16 branch backport-8.0 Automated backport with mergify labels Nov 24, 2021
@bmorelli25 bmorelli25 self-assigned this Nov 24, 2021
@apmmachine
Copy link
Contributor

apmmachine commented Nov 24, 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-11-29T17:14:49.515+0000

  • Duration: 43 min 38 sec

  • Commit: d884337

Test stats 🧪

Test Results
Failed 0
Passed 5586
Skipped 19
Total 5605

🤖 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.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@bmorelli25 bmorelli25 changed the title docs: first round of "deprecating soon" notices docs: Add "deprecating soon" notices Nov 24, 2021
@bmorelli25 bmorelli25 marked this pull request as ready for review November 25, 2021 02:02
@bmorelli25 bmorelli25 requested a review from a team November 25, 2021 02:02
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 great!

Copy link
Contributor

@simitt simitt left a comment

Choose a reason for hiding this comment

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

++ This looks great! Thanks for the effort you put in here.

@bmorelli25 bmorelli25 merged commit d5bd996 into elastic:master Nov 29, 2021
@bmorelli25 bmorelli25 deleted the docs-deprecation-notice branch November 29, 2021 19:40
mergify bot pushed a commit that referenced this pull request Nov 29, 2021
mergify bot pushed a commit that referenced this pull request Nov 29, 2021
(cherry picked from commit d5bd996)

# Conflicts:
#	docs/legacy/copied-from-beats/docs/https.asciidoc
#	docs/legacy/transaction-metrics.asciidoc
bmorelli25 added a commit that referenced this pull request Nov 29, 2021
(cherry picked from commit d5bd996)

Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
bmorelli25 added a commit that referenced this pull request Nov 29, 2021
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants