-
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
[Doc] Replace wrong links to external numeral docs, instead use Kibana docs #84167
Comments
Pinging @elastic/kibana-docs (Team:Docs) |
Pinging @elastic/kibana-app-services (Team:AppServices) |
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. |
@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? |
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. |
* 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
* 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
* 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
* 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
* 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
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.
The text was updated successfully, but these errors were encountered: