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

[data] Update uiSettings registered from data plugin to use core.docLinks #67026

Closed
Tracked by #55919
lukeelmers opened this issue May 19, 2020 · 4 comments
Closed
Tracked by #55919
Labels
chore Feature:Search Querying infrastructure in Kibana impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort technical debt Improvement of the software architecture and operational architecture

Comments

@lukeelmers
Copy link
Member

The data plugin registers several uiSettings in src/plugins/data/server/ui_settings.ts.

Many of these settings include inline links to the docs in their description.

When we moved these settings into data in #66040, we discussed that ideally these links should come from the core.docLinks service, which ensures they are pointing to the correct version of the docs instead of current.

This issue tracks work to extract the links from data's uiSettings, and move them to the docLinks service.

@lukeelmers lukeelmers added chore technical debt Improvement of the software architecture and operational architecture Team:AppArch labels May 19, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app-arch (Team:AppArch)

@lukeelmers lukeelmers added impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort labels May 19, 2020
@wylieconlon
Copy link
Contributor

@lukeelmers I see you've tagged this as a low-effort fix. What are you thinking the implementation requirements are? I've identified this bug in the docs: #84167

@lukeelmers
Copy link
Member Author

lukeelmers commented Nov 24, 2020

@wylieconlon This would be a 3-step process:

  1. Add links that are in src/plugins/data/server/ui_settings.ts to the core docLinks service in src/core/public/doc_links/doc_links_service.ts.
  2. Expose docLinks service on the server (currently it's only on the client)
  3. Update src/plugins/data/server/ui_settings.ts to consume URLs via docLinks service

Of these tasks, item 2 is really the only one that would require a bit of coordination with the core team. Otherwise it's fairly straightforward as the doclinks service is simply a hardcoded object of URL strings.

@ppisljar ppisljar added the Feature:Search Querying infrastructure in Kibana label May 10, 2021
@exalate-issue-sync exalate-issue-sync bot added loe:medium Medium Level of Effort and removed loe:small Small Level of Effort labels Jun 2, 2021
@exalate-issue-sync exalate-issue-sync bot added loe:small Small Level of Effort and removed loe:medium Medium Level of Effort labels Jan 4, 2022
@ppisljar
Copy link
Member

Thank you for contributing to this issue, however, we are closing this issue due to inactivity as part of a backlog grooming effort. If you believe this feature/bug should still be considered, please reopen with a comment.

@ppisljar ppisljar closed this as not planned Won't fix, can't repro, duplicate, stale Aug 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Feature:Search Querying infrastructure in Kibana impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort technical debt Improvement of the software architecture and operational architecture
Projects
None yet
Development

No branches or pull requests

4 participants