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.

Sign up for GitHub

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

Jump to bottom

Use doc link services in CCR #98436

Merged
merged 8 commits into from
Apr 30, 2021
Merged

Use doc link services in CCR #98436

merged 8 commits into from
Apr 30, 2021

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Apr 27, 2021 •
edited
Loading

Summary

Related to #88107

This PR removes hard-coded links from https://github.com/elastic/kibana/blob/master/x-pack/plugins/cross_cluster_replication/public/app/services/documentation_links.ts, replacing them with keywords from the documentation link service.

In the long run, this documentation_links.ts file should likely be removed and the doc link service called directly instead (i.e. from https://github.com/elastic/kibana/blob/master/x-pack/plugins/cross_cluster_replication/public/app/components/auto_follow_pattern_page_title.js, https://github.com/elastic/kibana/blob/master/x-pack/plugins/cross_cluster_replication/public/app/components/follower_index_page_title.js, and https://github.com/elastic/kibana/blob/master/x-pack/plugins/cross_cluster_replication/public/app/components/follower_index_form/advanced_settings_fields.js).

Screenshots

  1. Auto follow pattern docs link:
    image

  2. Follower index docs link:
    image

  3. Learn more links:

image

@lcawl lcawl added the WIP Work in progress label Apr 27, 2021
@lcawl lcawl mentioned this pull request Apr 27, 2021
Closed
@lcawl lcawl added enhancement New value added to drive a business result Feature:CCR and Remote Clusters release_note:skip Skip the PR/issue when compiling release notes v7.14.0 v8.0.0 and removed WIP Work in progress labels Apr 28, 2021
@lcawl lcawl marked this pull request as ready for review April 28, 2021 14:59
@lcawl lcawl requested review from a team as code owners April 28, 2021 14:59
@lcawl
Copy link
Contributor Author

lcawl commented Apr 28, 2021

To address the "Metrics - page load bundle size" error, is it appropriate to run the following command?:

node scripts/build_kibana_platform_plugins --update-limits

@alisonelizabeth alisonelizabeth added the Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more label Apr 28, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/es-ui (Team:Elasticsearch UI)

@alisonelizabeth alisonelizabeth mentioned this pull request Apr 29, 2021
Open
alisonelizabeth
alisonelizabeth approved these changes Apr 29, 2021
View reviewed changes
Copy link
Contributor

@alisonelizabeth alisonelizabeth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this @lcawl!

I pushed another change to simplify the logic in advanced_settings_fields.js. I also left a nit about the changes to the doc link service, but otherwise everything LGTM.

I’ll defer to the core team around the page load bundle size error.

For awareness to anyone that looks at this PR, the documentation links for byte size and time units appeared to be broken prior to this PR (not sure at one point the issue was introduced).

Screen Shot 2021-04-27 at 8 11 49 PM

I worked with Lisa to resolve this and made changes to advanced_settings_fields.js.

Unrelated to the documentation links, but I also came across a bug while creating a follower index in CCR and opened #98700.

src/core/public/doc_links/doc_links_service.ts
@@ -309,6 +309,9 @@ export class DocLinksService {
},
apis: {
bulkIndexAlias: `${ELASTICSEARCH_DOCS}indices-aliases.html`,
byteSizeUnits: `${ELASTICSEARCH_DOCS}common-options.html#byte-units`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit] I see there's also an elasticsearch property. I'm not as familiar with how the doc links are organized, but that seems like it might be more appropriate than to live under apis.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page is a subsection of a long "API conventions" page, which is why I put it under "apis" in the link service. If we end up having to differentiate between conventions for Cloud/Kibana/Elasticsearch APIs, then maybe it's worth revisiting but I'll stick with this for now unless you have strong objections.

src/core/public/doc_links/doc_links_service.ts
@@ -329,6 +332,7 @@ export class DocLinksService {
putSnapshotLifecyclePolicy: `${ELASTICSEARCH_DOCS}slm-api-put-policy.html`,
putWatch: `${ELASTICSEARCH_DOCS}watcher-api-put-watch.html`,
simulatePipeline: `${ELASTICSEARCH_DOCS}simulate-pipeline-api.html`,
timeUnits: `${ELASTICSEARCH_DOCS}common-options.html#time-units`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

similar comment here

@alisonelizabeth
Copy link
Contributor

@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
crossClusterReplication 292.8KB 293.4KB +604.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 400.3KB 400.6KB +262.0B
crossClusterReplication 25.0KB 24.9KB -123.0B
total +139.0B

History

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

@lcawl lcawl merged commit 23b832b into elastic:master Apr 30, 2021
@lcawl lcawl deleted the ccr-links branch April 30, 2021 16:05
@lcawl lcawl mentioned this pull request Apr 30, 2021
Merged
lcawl added a commit to lcawl/kibana that referenced this pull request Apr 30, 2021
@lcawl @alisonelizabeth
Use doc link services in CCR (elastic#98436)
1264308 
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
lcawl added a commit that referenced this pull request Apr 30, 2021
@lcawl @alisonelizabeth
Use doc link services in CCR (#98436) (#98937)
07b821b 
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>

Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
@lcawl lcawl mentioned this pull request May 3, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alisonelizabeth alisonelizabeth alisonelizabeth approved these changes

@pgayvallet pgayvallet pgayvallet approved these changes

Assignees
No one assigned
Labels
enhancement New value added to drive a business result Feature:CCR and Remote Clusters release_note:skip Skip the PR/issue when compiling release notes Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v7.14.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@lcawl @elasticmachine @alisonelizabeth @kibanamachine @pgayvallet