-
Notifications
You must be signed in to change notification settings - Fork 525
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
docs: Add "deprecating soon" notices #6708
Conversation
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
🤖 GitHub commentsTo re-run your PR in the CI, just comment with:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great!
There was a problem hiding this 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.
(cherry picked from commit d5bd996)
(cherry picked from commit d5bd996) # Conflicts: # docs/legacy/copied-from-beats/docs/https.asciidoc # docs/legacy/transaction-metrics.asciidoc
Summary
The main purpose of this PR was:
Along the way (I had to look at every single file in the legacy docs) I noticed a few things:
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:
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!apm-server/docs/notices.asciidoc
Lines 1 to 19 in 8467edf
Preview
Click me