-
Notifications
You must be signed in to change notification settings - Fork 106
Update agent/common-problems.md #1920
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
base: main
Are you sure you want to change the base?
Conversation
Cross-link [Agent diag](https://www.elastic.co/docs/troubleshoot/ingest/fleet/common-problems#trb-collect-agent-diagnostics) to its [CLI diag](https://www.elastic.co/docs/reference/fleet/agent-command-reference#elastic-agent-diagnostics-command) counterpart.
🔍 Preview links for changed docs: 🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes. |
@@ -362,7 +362,7 @@ The ZIP archive containing diagnostics information will include the raw events o | |||
**Get the diagnostics bundle using the CLI** | |||
Run the following command to generate a zip archive containing diagnostics information that the Elastic team can use for debugging cases. | |||
Run the following [Agent command](https://www.elastic.co/docs/reference/fleet/agent-command-reference#elastic-agent-diagnostics-command) to generate a zip archive containing diagnostics information that the Elastic team can use for debugging cases. |
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.
Thank you! A few thoughts:
- Even though we're already in the Elastic Agent docs, we should use the full name, "Elastic Agent" to distinguish between Elastic Agent and APM Agents.
- Because the page you're linking to is in the same repo, you should use one of our two internal link syntaxes.
- I would change the link to be the name of the command to give more context as to where the user is being linked off to.
Run the following [Agent command](https://www.elastic.co/docs/reference/fleet/agent-command-reference#elastic-agent-diagnostics-command) to generate a zip archive containing diagnostics information that the Elastic team can use for debugging cases. | |
Run the [`diagnostics` command](/reference/fleet/agent-command-reference#elastic-agent-diagnostics-command) to generate a zip archive containing diagnostics information that the Elastic team can use for debugging cases: |
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.
Thanks, @bmorelli25 ! (And the link to know how to do this myself in the future!)
Your change doesn't pass pipeline:
FWIW I need the sub-#
not just the base file. I may be missing the obvious, but I don't see cross-page anchors listed in your linked guide.
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.
Your change doesn't pass pipeline:
Sorry! See comment below.
I may be missing the obvious, but I don't see cross-page anchors listed in your linked guide.
This is good feedback. It is not obvious in the docs that you can do this with internal links. There is (kind of) an example wayyy down the page but it's in a different section. Let me add a better example into these docs.
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.
Clarified in elastic/docs-builder#1447
Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Brandon Morelli <[email protected]>
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.
🚢
Cross-link Agent diag to its CLI diag counterpart.