Move from hard-coded links to documentation link service #88107
Description
The following list of hard-coded doc links exist in master and should ideally be shifted to using doc link service keywords so they're easier to maintain in a single location.
Per #123818, in 8.1 and later versions, the updates should occur in https://github.com/elastic/kibana/blob/main/packages/kbn-doc-links/src/get_doc_links.ts instead.
Kibana
Alerting (see #88231):
- x-pack/plugins/stack_alerts/public/alert_types/threshold/index.ts. See [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. #92953
- x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email_connector.tsx See [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. #92953
- x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/es_index/es_index_connector.tsx See [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. #92953
- x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/es_index/es_index_params.tsx See [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. #92953
- x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/pagerduty/pagerduty_connectors.tsx See [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. #92953
- x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/servicenow_connectors.tsx See [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. #92953
- x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/slack/slack_connectors.tsx See [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. #92953
- x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/teams/teams_connectors.tsx See [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. #92953
- x-pack/plugins/triggers_actions_ui/public/application/components/health_check.tsx See [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. #92953
- x-pack/plugins/triggers_actions_ui/public/application/home.tsx See [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. #92953
- x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/action_connector_form.tsx See [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. #92953
- x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/connector_edit_flyout.tsx See [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. #92953
Canvas
- x-pack/plugins/canvas/public/services/platform.ts ...defines partial URLs in functions like getElasticWebsiteUrl which is then used in x-pack/plugins/canvas/public/lib/documentation_links.ts See Use doc links service for Canvas #97059
Dashboard
- src/plugins/dashboard/public/application/lib/help_menu_util.ts See Use doc links service for Dashboard and Discover help links #87224
Discover
- src/plugins/discover/public/application/components/help_menu/help_menu_util.js See Use doc links service for Dashboard and Discover help links #87224
- src/plugins/discover/public/application/components/doc/doc.tsx See [DOCS] Uses doc link service in discover #88835
Index field pattern editor
- index_pattern_field_editor/public/lib/documentation.ts See Use documentation link service for index pattern field editor #100609
Index patterns
- src/plugins/index_pattern_management/public/components/edit_index_pattern/edit_index_pattern.tsx. See Use doc link services in index pattern management #89937
Lens
License management
- x-pack/plugins/license_management/public/plugin.ts See Use documentation link service for security links #87409
Maps
Monitoring
- x-pack/plugins/monitoring/public/alerts/ccr_read_exceptions_alert/index.tsx See #88920
- x-pack/plugins/monitoring/public/alerts/cpu_usage_alert/cpu_usage_alert.tsx See #88920
- x-pack/plugins/monitoring/public/alerts/disk_usage_alert/index.tsx See #88920
- x-pack/plugins/monitoring/public/alerts/legacy_alert/legacy_alert.tsx See #88920
- x-pack/plugins/monitoring/public/alerts/lib/alerts_toasts.tsx See Use doc link service in more Stack Monitoring pages #89050
- x-pack/plugins/monitoring/public/alerts/memory_usage_alert/index.tsx See #88920
- x-pack/plugins/monitoring/public/alerts/missing_monitoring_data_alert/missing_monitoring_data_alert.tsx See #88920
- x-pack/plugins/monitoring/public/alerts/thread_pool_rejections_alert/index.tsx See #88920
- x-pack/plugins/monitoring/public/components/logs/reason.js See Use doc link service in more Stack Monitoring pages #89050
- x-pack/plugins/monitoring/public/components/metricbeat_migration/flyout/flyout.js See Use doc link service in more Stack Monitoring pages #89050
- x-pack/plugins/monitoring/public/components/metricbeat_migration/instruction_steps/apm/enable_metricbeat_instructions.js See Use doc link service in more Stack Monitoring pages #89050
- x-pack/plugins/monitoring/public/components/metricbeat_migration/instruction_steps/beats/enable_metricbeat_instructions.js See Use doc link service in more Stack Monitoring pages #89050
- x-pack/plugins/monitoring/public/components/metricbeat_migration/instruction_steps/elasticsearch/enable_metricbeat_instructions.js See Use doc link service in more Stack Monitoring pages #89050
- x-pack/plugins/monitoring/public/components/metricbeat_migration/instruction_steps/kibana/enable_metricbeat_instructions.js See Use doc link service in more Stack Monitoring pages #89050
- x-pack/plugins/monitoring/public/components/metricbeat_migration/instruction_steps/logstash/enable_metricbeat_instructions.js See Use doc link service in more Stack Monitoring pages #89050
- https://github.com/elastic/kibana/blob/master/x-pack/plugins/monitoring/public/lib/internal_monitoring_toasts.tsx See Use doc link service in more Stack Monitoring pages #89050
Spaces
- x-pack/plugins/spaces/public/lib/documentation_links.ts See Use documentation link service for security links #87409
UI settings
- src/plugins/data/server/ui_settings.ts Requires [core] docLinks server-side service #95389. See Use docLinks service for ui settings in Discover and Data plugins #124302
- src/plugins/discover/server/ui_settings.ts Requires [core] docLinks server-side service #95389 per investigation in [Discover] Update Field statistics toggle in Discover & Advanced settings description to include docs #122344. See Use docLinks service for ui settings in Discover and Data plugins #124302
Upgrade Assistant
- x-pack/plugins/upgrade_assistant/public/application/components/tabs/checkup/deprecations/reindex/flyout/container.tsx: Use doc link service in Upgrade Assistant #91573
Visualize
- src/plugins/visualize/public/application/utils/utils.ts See Fix broken documentation link in Visualize app #87250
Elasticsearch
CCR
- x-pack/plugins/cross_cluster_replication/public/app/index.tsx See Use doc link services in CCR #98436
- x-pack/plugins/cross_cluster_replication/public/plugin.ts See Use doc link services in CCR #98436
- x-pack/plugins/cross_cluster_replication/public/app/services/documentation_links.ts See Use doc link services in CCR #98436
ILM
- x-pack/plugins/index_lifecycle_management/public/plugin.tsx Use doc link service in ILM #122104
- x-pack/plugins/index_lifecycle_management/public/application/services/documentation.ts Use doc link service in ILM #122104
- [ ] x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/cold_phase/cold_phase.tsx
- [ ] x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/delete_phase/delete_phase.tsx - x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/hot_phase/hot_phase.tsx Use doc link service in ILM #122104
- x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/shared_fields/data_tier_allocation_field/components/node_allocation.tsx Use doc link service in ILM #122104
- x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/shared_fields/data_tier_allocation_field/components/no_custom_attributes_messages.tsx See Use documentation link service in index lifecycle management #118623
- x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/shared_fields/forcemerge_field.tsx … Use doc link service in ILM #122104
Index management:
- x-pack/plugins/index_management/public/application/components/component_templates/lib/documentation.ts. See Use doc link services in index management #89957 and [Index Management] Remove documentation service #96910
- x-pack/plugins/index_management/public/application/services/documentation.ts. See Use doc link services in index management #89957
- x-pack/plugins/index_management/public/application/components/mappings_editor/constants/data_types_definition.tsx (are the *.html files here going to the external docs?) See [Index Management] Remove documentation service #96910
- x-pack/plugins/index_management/public/application/components/shared/components/wizard_steps/step_aliases.tsx See [Index Management] Remove documentation service #96910
- x-pack/plugins/index_management/public/application/components/shared/components/wizard_steps/step_mappings.tsx See [Index Management] Remove documentation service #96910
- x-pack/plugins/index_management/public/application/components/shared/components/wizard_steps/step_settings.tsx See [Index Management] Remove documentation service #96910
- x-pack/plugins/index_management/public/application/components/template_form/steps/step_components.tsx See [Index Management] Remove documentation service #96910
Ingest pipelines
-
x-pack/plugins/ingest_pipelines/public/application/services/documentation.ts See Update doc links for ingest pipelines app #94742
-
x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/dissect.tsx See Update more doc links for ingest pipelines app #112767
-
x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/enrich.tsx See Update more doc links for ingest pipelines app #112767
-
x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/inference.tsx See Update more doc links for ingest pipelines app #112767
-
x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/test_pipeline/test_pipeline_tabs/tab_documents/tab_documents.tsx See Update more doc links for ingest pipelines app #112767
-
https://github.com/elastic/kibana/blob/master/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx - Reference to [Kibana Docs] Provide explanation of Logstash Centralized Pipeline Management #23486
Painless
Remote clusters
- https://github.com/elastic/kibana/blob/master/x-pack/plugins/remote_clusters/public/application/services/documentation.ts ?? Use documentation link service for remote clusters #93937
Rollup
Runtime fields
- x-pack/plugins/runtime_fields/public/lib/documentation.ts: Use documentation link service for runtime fields #95256
Security
- x-pack/plugins/security/public/management/api_keys/documentation_links.ts See Use documentation link service for security links #87409
- x-pack/plugins/security/public/management/role_mappings/documentation_links.ts See Use documentation link service for security links #87409
- x-pack/plugins/security/public/management/roles/documentation_links.ts See Use documentation link service for security links #87409
- https://github.com/elastic/kibana/blob/master/x-pack/plugins/security/public/security_checkup/documentation_links.ts See Use documentation link service for security links #87409
- Remove unnecessary documentation_links.ts files See Use documentation links service provided by the core directly. #88158
Snapshot restore
- x-pack/plugins/snapshot_restore/public/application/services/documentation/documentation_links.ts. See Use documentation link service for snapshot restore #91596
Transforms
- x-pack/plugins/transform/public/app/constants/index.ts See [ML] Use doc links service for transforms #86919
Watcher
- x-pack/plugins/watcher/public/application/app_context.tsx See Use documentation link service for Watcher #93339
Machine learning
- x-pack/plugins/ml/common/constants/messages.ts: [ML] Anomaly Detection: Migrate validation messages links to use docLinks. #94568
- Various, fixed in [ML] Use documentation link service in more ML pages #87389, [ML] Add doc link in help menu on more ML pages #86500, [ML] Use doc links service for more ML pages #86405
Observability
Infra
- x-pack/plugins/infra/public/alerting/inventory/index.ts See Replace hard-coded links in infra alerting #111072
- x-pack/plugins/infra/public/alerting/log_threshold/log_threshold_alert_type.ts See Replace hard-coded links in infra alerting #111072
- x-pack/plugins/infra/public/alerting/metric_anomaly/index.ts
- x-pack/plugins/infra/public/alerting/metric_threshold/index.ts See Replace hard-coded links in infra alerting #111072
- x-pack/plugins/infra/public/components/logging/log_analysis_setup/subscription_splash_content.tsx <...there are a bunch more like this if you search on *.html in the infra/public folder>
APM
- x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts See [APM] Replace hard-coded link to rules documentation #109021
- x-pack/plugins/apm/public/components/shared/Links/ElasticDocsLink.tsx, which is then used in:
- x-pack/plugins/apm/public/components/app/ServiceMap/EmptyBanner.tsx. See [APM] Use doc link service instead of ElasticDocsLink #109027
- x-pack/plugins/apm/public/components/app/ServiceMap/timeout_prompt.tsx See [APM] Use doc link service instead of ElasticDocsLink #109027
- x-pack/plugins/apm/public/components/app/Settings/CustomizeUI/CustomLink/CreateEditCustomLinkFlyout/Documentation.tsx [APM] Uses doc link service instead of ElasticDocsLink for linking custom links #111149
- x-pack/plugins/apm/public/components/app/transaction_overview/index.tsx
- x-pack/plugins/apm/public/components/app/TransactionDetails/WaterfallWithSummmary/WaterfallContainer/Waterfall/TransactionFlyout/DroppedSpansWarning.tsx [APM] Uses doc link service instead of ElasticDocsLink for linking dropped transaction spans #110964
- x-pack/plugins/apm/public/components/shared/MetadataTable/index.tsx [APM] Uses doc link service instead of ElasticDocsLink for linking metadata #110992
- x-pack/plugins/apm/public/components/app/service_node_metrics/index.tsx [APM] Uses doc link service instead of ElasticDocsLink for linking upgrading info #111155
Beats management
- [ ] x-pack/plugins/beats_management/public/pages/overview/enrolled_beats.tsx
Fleet
- [ ] x-pack/plugins/fleet/public/applications/fleet/components/alpha_flyout.tsx
- [ ] x-pack/plugins/fleet/public/applications/fleet/components/enrollment_instructions/manual/index.tsx
- [ ] x-pack/plugins/fleet/public/applications/fleet/sections/agents/setup_page/index.tsx
Uptime
- x-pack/plugins/uptime/public/apps/render_app.tsx See Replace hard-coded doc links in uptime #111075
- x-pack/plugins/uptime/public/lib/alert_types/duration_anomaly.tsx See Replace hard-coded doc links in uptime #111075
- x-pack/plugins/uptime/public/lib/alert_types/monitor_status.tsx See Replace hard-coded doc links in uptime #111075
- x-pack/plugins/uptime/public/lib/alert_types/tls.tsx See Replace hard-coded doc links in uptime #111075
- x-pack/plugins/uptime/public/components/common/location_link.tsx <... there are more like this if you search in public/components for *.html>
Security
- x-pack/plugins/security_solution/public/common/components/help_menu/index.tsx see Adds ECS guide to doc links service #102246
- x-pack/plugins/security_solution/public/common/components/links_to_docs/doc_link.tsx
- [ ] x-pack/plugins/security_solution/public/cases/pages/saved_object_no_permissions.tsx - x-pack/plugins/security_solution/public/common/components/ml_popover/ml_popover.tsx See [SECURITY] Adds security links to doc link service #102676
- x-pack/plugins/security_solution/public/detections/components/rules/pre_packaged_rules/update_callout.test.tsx See [SECURITY] Adds security links to doc link service #102676
- x-pack/plugins/security_solution/public/detections/pages/detection_engine/detection_engine_no_index.tsx See [SECURITY] Adds security links to doc link service #102676
- x-pack/plugins/security_solution/public/detections/pages/detection_engine/detection_engine_user_unauthenticated.tsx See [SECURITY] Adds security links to doc link service #102676
- x-pack/plugins/security_solution/public/network/components/embeddables/embedded_map.tsx See [SECURITY] Adds security links to doc link service #102676
- x-pack/plugins/security_solution/public/network/components/embeddables/index_patterns_missing_prompt.tsx See [SECURITY] Adds security links to doc link service #102676
- x-pack/plugins/security_solution/public/management/components/management_empty_state.tsx See [SECURITY] Adds security links to doc link service #102676
- x-pack/plugins/security_solution/public/timelines/components/row_renderers_browser/catalog/index.tsx
Search
- x-pack/plugins/enterprise_search/public/applications/app_search/components/document_creation/creation_mode_components/api_code_example.tsx Add workplace search links to doc link service #118814
- x-pack/plugins/enterprise_search/public/applications/app_search/components/document_creation/document_creation_buttons.tsx Add workplace search links to doc link service #118814
- [ ] x-pack/plugins/enterprise_search/public/applications/app_search/components/documents/search_experience/search_experience_content.tsx - x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_overview/engine_overview_empty.tsx Add workplace search links to doc link service #118814
- x-pack/plugins/enterprise_search/public/applications/app_search/components/settings/log_retention/log_retention_panel.tsx Add workplace search links to doc link service #118814
- [ ] x-pack/plugins/enterprise_search/public/applications/app_search/components/setup_guide/setup_guide.tsx - x-pack/plugins/enterprise_search/public/applications/enterprise_search/components/setup_guide/setup_guide.tsx Add workplace search links to doc link service #118814
- x-pack/plugins/enterprise_search/public/applications/shared/setup_guide/setup_guide.tsx Add workplace search links to doc link service #118814
- x-pack/plugins/enterprise_search/public/applications/workplace_search/views/setup_guide/setup_guide.tsx Add workplace search links to doc link service #118814
- x-pack/plugins/enterprise_search/public/applications/shared/doc_links/doc_links.ts Add workplace search links to doc link service #118814
Integrations
- src/plugins/custom_integrations/server/language_clients/index.ts Requires server-side doc link service
Console
- The "Go to documentation" links within the Console autocomplete menu pull hard-coded URLs from the Elasticsearch REST specs per https://github.com/elastic/kibana/blob/main/packages/kbn-spec-to-console/README.md and clean up the version per https://github.com/elastic/kibana/blob/main/src/plugins/console/public/application/containers/editor/legacy/console_menu_actions.ts