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

[Doc] Replace wrong links to external numeral docs, instead use Kibana docs #84167

Closed
wylieconlon opened this issue Nov 23, 2020 · 5 comments · Fixed by #94858
Closed

[Doc] Replace wrong links to external numeral docs, instead use Kibana docs #84167

wylieconlon opened this issue Nov 23, 2020 · 5 comments · Fixed by #94858
Assignees
Labels
bug Fixes for quality problems that affect the customer experience Feature:Data Views Data Views code and UI - index patterns before 8.0 Feature:FieldFormatters Feature:Kibana Management Feature label for Data Views, Advanced Setting, Saved Object management pages impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:small Small Level of Effort Team:Docs

Comments

@wylieconlon
Copy link
Contributor

Many months ago we took an important step to remove numeral from Kibana, and since then the Kibana docs have diverged from the library we forked. Our docs are not actually linked from all the places they need to be, which is a bug: https://www.elastic.co/guide/en/kibana/current/numeral.html

Specifically, there are two main places that have technical barriers to linking to the correct docs:

  • The Kibana "Advanced Settings", which can't use the docLinks service because of technical debt. Can we hardcode the link to elastic.co into the docs @gchaps?

  • The number field formatter section of Index Pattern Management, which is directly linking to the wrong Github project. This is a bug.

@wylieconlon wylieconlon added bug Fixes for quality problems that affect the customer experience Team:Docs Team:AppServices labels Nov 23, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app-services (Team:AppServices)

@lcawl
Copy link
Contributor

lcawl commented Nov 23, 2020

Can we hardcode the link to elastic.co into the docs

I think anything you can do to rely on ELASTIC_WEBSITE_URL and DOC_LINK_VERSION variables as is done in some other apps will save you from cleanup when we (hopefully) have significant changes to the URLs in the coming year. We'll have a lot of redirects nonetheless.

@wylieconlon
Copy link
Contributor Author

@lcawl Because of the linked tech debt issue, that isn't an option here. The fix for that tech debt is not a high priority, so what are the options for working around this limitation?

@lcawl
Copy link
Contributor

lcawl commented Nov 30, 2020

After further discussion with @wylieconlon I better understand that the goal here is to fix places in Kibana where we have outdated links to external websites (like numeraljs.com). If it's not possible to replace those with links to version-specific documentation, I agree that linking to "current" URLs is better than leaving them as-is.

@Dosant Dosant added Feature:FieldFormatters Feature:Data Views Data Views code and UI - index patterns before 8.0 Feature:Kibana Management Feature label for Data Views, Advanced Setting, Saved Object management pages impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:small Small Level of Effort triaged labels Feb 24, 2021
dokmic added a commit that referenced this issue Mar 18, 2021
* Fix links to the numeral formatting in the advanced settings (#84167)
* Fix a link to the numeral formatting in the index pattern field settings (#84167)
dokmic added a commit to dokmic/kibana that referenced this issue Mar 18, 2021
* Fix links to the numeral formatting in the advanced settings (elastic#84167)
* Fix a link to the numeral formatting in the index pattern field settings (elastic#84167)
# Conflicts:
#	docs/development/core/public/kibana-plugin-core-public.doclinksstart.md
dokmic added a commit to dokmic/kibana that referenced this issue Mar 18, 2021
* Fix links to the numeral formatting in the advanced settings (elastic#84167)
* Fix a link to the numeral formatting in the index pattern field settings (elastic#84167)
# Conflicts:
#	docs/development/core/public/kibana-plugin-core-public.doclinksstart.md
#	src/core/public/doc_links/doc_links_service.ts
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/bytes/__snapshots__/bytes.test.tsx.snap
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/number/__snapshots__/number.test.tsx.snap
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/number/number.tsx
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/percent/__snapshots__/percent.test.tsx.snap
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/percent/percent.test.tsx
dokmic added a commit to dokmic/kibana that referenced this issue Mar 18, 2021
* Fix links to the numeral formatting in the advanced settings (elastic#84167)
* Fix a link to the numeral formatting in the index pattern field settings (elastic#84167)
# Conflicts:
#	docs/development/core/public/kibana-plugin-core-public.doclinksstart.md
#	src/core/public/doc_links/doc_links_service.ts
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/bytes/__snapshots__/bytes.test.tsx.snap
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/number/__snapshots__/number.test.tsx.snap
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/number/number.tsx
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/percent/__snapshots__/percent.test.tsx.snap
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/percent/percent.test.tsx
dokmic added a commit that referenced this issue Mar 18, 2021
* Fix links to the numeral formatting in the advanced settings (#84167)
* Fix a link to the numeral formatting in the index pattern field settings (#84167)
# Conflicts:
#	docs/development/core/public/kibana-plugin-core-public.doclinksstart.md
dokmic added a commit that referenced this issue Mar 18, 2021
* Fix links to the numeral formatting in the advanced settings (#84167)
* Fix a link to the numeral formatting in the index pattern field settings (#84167)
# Conflicts:
#	docs/development/core/public/kibana-plugin-core-public.doclinksstart.md
#	src/core/public/doc_links/doc_links_service.ts
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/bytes/__snapshots__/bytes.test.tsx.snap
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/number/__snapshots__/number.test.tsx.snap
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/number/number.tsx
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/percent/__snapshots__/percent.test.tsx.snap
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/percent/percent.test.tsx
dokmic added a commit that referenced this issue Mar 18, 2021
* Fix links to the numeral formatting in the advanced settings (#84167)
* Fix a link to the numeral formatting in the index pattern field settings (#84167)
# Conflicts:
#	docs/development/core/public/kibana-plugin-core-public.doclinksstart.md
#	src/core/public/doc_links/doc_links_service.ts
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/bytes/__snapshots__/bytes.test.tsx.snap
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/number/__snapshots__/number.test.tsx.snap
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/number/number.tsx
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/percent/__snapshots__/percent.test.tsx.snap
#	src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/percent/percent.test.tsx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience Feature:Data Views Data Views code and UI - index patterns before 8.0 Feature:FieldFormatters Feature:Kibana Management Feature label for Data Views, Advanced Setting, Saved Object management pages impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:small Small Level of Effort Team:Docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants