-
Notifications
You must be signed in to change notification settings - Fork 107
apm: Refactor outdated cloud apm settings docs #2027
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
This reverts commit f4cd139.
reference/apm/cloud/apm-settings.md
Outdated
@@ -1,376 +0,0 @@ | |||
--- | |||
mapped_pages: | |||
- https://www.elastic.co/guide/en/cloud/current/ec-manage-apm-settings.html#ec-apm-settings |
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 is removing the page, so we may need to redirect this retired page then.
Note, it also needs to be removed from the corresponding toc.yml
🔍 Preview links for changed docs |
reference/apm/cloud/apm-settings.md
Outdated
@@ -47,330 +47,12 @@ If a setting is not supported by {{ech}}, you will get an error message when you | |||
|
|||
## Supported standalone APM settings (legacy) [ec-apm-settings] | |||
|
|||
{{ech}} supports the following setting when running APM in standalone mode (legacy). | |||
{{ech}} supports the settings listed in [APM documentation](/solutions/observability/apm/configure-apm-server.md) under "APM Server binary" when running APM in standalone mode (legacy). For versions before 9, refer to [older documentation](https://www.elastic.co/guide/en/observability/8.x/apm-configuring-howto-apm-server.html). |
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.
@florent-leborgne is there a way to easily link to old (non-docsv3) docs from docs v3?
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.
From that page, there's a version dropdown that will allow users to browse to older 8.x versions of that page, so I wouldn't necessarily add a link to old versions here.
If you think it's very important, then the way you did it is the only way to my knowledge. Note that 8.x will become 8.19 so the link will not stay valid for very long. I suggest you either add this link after the release (or never 😅), or point to 8.18.
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.
Well, in this case they are all "There are no other versions available for this page." which isn't super helpful. I've updated the link to 8.18 docs. While I don't love it, it seems to be the most user friendly way
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.
Fair enough I don't know that space enough to be sure of how the mapping to older pages was handled. This link sounds like a good alternative
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.
Content changes LGTM
Standalone APM (legacy) on ECH should refer to general APM configuration docs to improve docs maintainability. The actual ECH user settings involves allowlist and denylist which can be too complicated to document. Add a generic statement that some settings may be restricted instead.
The outdated pages are
Fixes elastic/apm-server#13602