-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[APM] Uses doc link service instead of ElasticDocsLink for linking metadata #110992
Conversation
Pinging @elastic/apm-ui (Team:apm) |
@@ -24,6 +24,7 @@ export class DocLinksService { | |||
const KIBANA_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/`; | |||
const FLEET_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/fleet/${DOC_LINK_VERSION}/`; | |||
const PLUGIN_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/plugins/${DOC_LINK_VERSION}/`; | |||
const APM_GET_STARTED_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/apm/get-started/${DOC_LINK_VERSION}/`; |
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.
const APM_GET_STARTED_DOCS =
${ELASTIC_WEBSITE_URL}guide/en/apm/get-started/${DOC_LINK_VERSION}/
;
Note that for this new constant to be checked properly, you'll also need to add it to the build_docs.pl as I did for the KIBANA_DOCS one here: elastic/docs#2132
If we end up needing links to the APM Server or APM agents books too, we might reconsider only having a single APM constant that is just ${ELASTIC_WEBSITE_URL}guide/en/apm/
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.
@lcawl Thanks for the info, I changed the constant and opened elastic/docs#2209 to add the check for the new constant.
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.
One comment, otherwise LGTM
@elasticmachine merge upstream |
💚 Build SucceededMetrics [docs]Async chunks
Page load bundle
History
To update your PR or re-run it, just comment with: |
Summary
Related to #88107
This PR replaces the need for https://github.com/elastic/kibana/blob/master/x-pack/plugins/apm/public/components/shared/Links/ElasticDocsLink.tsx in the index file of the Metadata Table in the APM app. Instead, it uses the https://github.com/elastic/kibana/blob/master/src/core/public/doc_links/doc_links_service.ts, which is checked as part of the documentation builds.