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

[APM] Uses doc link service instead of ElasticDocsLink for linking metadata #110992

Merged
merged 5 commits into from
Sep 6, 2021

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Sep 2, 2021

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.

@szabosteve szabosteve added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.16.0 labels Sep 2, 2021
@szabosteve szabosteve requested review from a team as code owners September 2, 2021 14:15
@botelastic botelastic bot added the Team:APM All issues that need APM UI Team support label Sep 2, 2021
@elasticmachine
Copy link
Contributor

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}/`;
Copy link
Contributor

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/

Copy link
Contributor Author

@szabosteve szabosteve Sep 3, 2021

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.

Copy link
Contributor

@lcawl lcawl left a 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

@szabosteve
Copy link
Contributor Author

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
apm 4.4MB 4.4MB +71.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
core 419.3KB 419.4KB +93.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:APM All issues that need APM UI Team support v7.16.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants