Use doc link services in index management

docs/development/core/public/kibana-plugin-core-public.doclinksstart.links.md

@@ -88,6 +88,7 @@ readonly links: {
             readonly top_hits: string;
         };
         readonly runtimeFields: {
+            readonly overview: string;
             readonly mapping: string;
         };
         readonly scriptedFields: {
@@ -114,9 +115,10 @@ readonly links: {
         };
         readonly query: {
             readonly eql: string;
+            readonly kueryQuerySyntax: string;
             readonly luceneQuerySyntax: string;
+            readonly percolate: string;
             readonly queryDsl: string;
-            readonly kueryQuerySyntax: string;
         };
         readonly date: {
             readonly dateMath: string;
@@ -143,6 +145,7 @@ readonly links: {
             painlessExecuteAPIContexts: string;
             putComponentTemplateMetadata: string;
             putSnapshotLifecyclePolicy: string;
+            putIndexTemplateV1: string;
             putWatch: string;
             updateTransform: string;
         }>;

src/core/public/doc_links/doc_links_service.ts

@@ -109,6 +109,7 @@ export class DocLinksService {
           top_hits: `${ELASTICSEARCH_DOCS}search-aggregations-metrics-top-hits-aggregation.html`,
         },
         runtimeFields: {
+          overview: `${ELASTICSEARCH_DOCS}runtime.html`,
           mapping: `${ELASTICSEARCH_DOCS}runtime-mapping-fields.html`,
         },
         scriptedFields: {
@@ -130,8 +131,49 @@ export class DocLinksService {
         addData: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/connect-to-elasticsearch.html`,
         kibana: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/index.html`,
         elasticsearch: {
+          docsBase: `${ELASTICSEARCH_DOCS}`,
+          asyncSearch: `${ELASTICSEARCH_DOCS}async-search-intro.html`,
+          dataStreams: `${ELASTICSEARCH_DOCS}data-streams.html`,
           indexModules: `${ELASTICSEARCH_DOCS}index-modules.html`,
+          indexSettings: `${ELASTICSEARCH_DOCS}index-modules.html#index-modules-settings`,
+          indexTemplates: `${ELASTICSEARCH_DOCS}indices-templates.html`,
           mapping: `${ELASTICSEARCH_DOCS}mapping.html`,
+          mappingAnalyzer: `${ELASTICSEARCH_DOCS}analyzer.html`,
+          mappingCoerce: `${ELASTICSEARCH_DOCS}coerce.html`,
+          mappingCopyTo: `${ELASTICSEARCH_DOCS}copy-to.html`,
+          mappingDocValues: `${ELASTICSEARCH_DOCS}doc-values.html`,
+          mappingDynamic: `${ELASTICSEARCH_DOCS}dynamic.html`,
+          mappingDynamicFields: `${ELASTICSEARCH_DOCS}dynamic-field-mapping.html`,
+          mappingDynamicTemplates: `${ELASTICSEARCH_DOCS}dynamic-templates.html`,
+          mappingEagerGlobalOrdinals: `${ELASTICSEARCH_DOCS}eager-global-ordinals.html`,
+          mappingEnabled: `${ELASTICSEARCH_DOCS}enabled.html`,
+          mappingFieldData: `${ELASTICSEARCH_DOCS}text.html#fielddata-mapping-param`,
+          mappingFieldDataEnable: `${ELASTICSEARCH_DOCS}text.html#before-enabling-fielddata`,
+          mappingFieldDataFilter: `${ELASTICSEARCH_DOCS}text.html#field-data-filtering`,
+          mappingFieldDataTypes: `${ELASTICSEARCH_DOCS}mapping-types.html`,
+          mappingFormat: `${ELASTICSEARCH_DOCS}mapping-date-format.html`,
+          mappingIgnoreAbove: `${ELASTICSEARCH_DOCS}ignore-above.html`,
+          mappingIgnoreMalformed: `${ELASTICSEARCH_DOCS}ignore-malformed.html`,
+          mappingIndex: `${ELASTICSEARCH_DOCS}mapping-index.html`,
+          mappingIndexOptions: `${ELASTICSEARCH_DOCS}index-options.html`,
+          mappingIndexPhrases: `${ELASTICSEARCH_DOCS}index-phrases.html`,
+          mappingIndexPrefixes: `${ELASTICSEARCH_DOCS}index-prefixes.html`,
+          mappingJoinFieldsPerformance: `${ELASTICSEARCH_DOCS}parent-join.html#_parent_join_and_performance`,
+          mappingMeta: `${ELASTICSEARCH_DOCS}mapping-field-meta.html`,
+          mappingMetaFields: `${ELASTICSEARCH_DOCS}mapping-meta-field.html`,
+          mappingNormalizer: `${ELASTICSEARCH_DOCS}normalizer.html`,
+          mappingNorms: `${ELASTICSEARCH_DOCS}norms.html`,
+          mappingNullValue: `${ELASTICSEARCH_DOCS}null-value.html`,
+          mappingParameters: `${ELASTICSEARCH_DOCS}mapping-params.html`,
+          mappingPositionIncrementGap: `${ELASTICSEARCH_DOCS}position-increment-gap.html`,
+          mappingRankFeatureFields: `${ELASTICSEARCH_DOCS}rank-feature.html`,
+          mappingRouting: `${ELASTICSEARCH_DOCS}mapping-routing-field.html`,
+          mappingSimilarity: `${ELASTICSEARCH_DOCS}similarity.html`,
+          mappingSourceFields: `${ELASTICSEARCH_DOCS}mapping-source-field.html`,
+          mappingSourceFieldsDisable: `${ELASTICSEARCH_DOCS}mapping-source-field.html#disable-source-field`,
+          mappingStore: `${ELASTICSEARCH_DOCS}mapping-store.html`,
+          mappingTermVector: `${ELASTICSEARCH_DOCS}term-vector.html`,
+          mappingTypesRemoval: `${ELASTICSEARCH_DOCS}removal-of-types.html`,
           nodeRoles: `${ELASTICSEARCH_DOCS}modules-node.html#node-roles`,
           remoteClusters: `${ELASTICSEARCH_DOCS}modules-remote-clusters.html`,
           remoteClustersProxy: `${ELASTICSEARCH_DOCS}modules-remote-clusters.html#proxy-mode`,
@@ -146,17 +188,19 @@ export class DocLinksService {
         },
         query: {
           eql: `${ELASTICSEARCH_DOCS}eql.html`,
+          kueryQuerySyntax: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/kuery-query.html`,
           luceneQuerySyntax: `${ELASTICSEARCH_DOCS}query-dsl-query-string-query.html#query-string-syntax`,
+          percolate: `${ELASTICSEARCH_DOCS}query-dsl-percolate-query.html`,
           queryDsl: `${ELASTICSEARCH_DOCS}query-dsl.html`,
-          kueryQuerySyntax: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/kuery-query.html`,
         },
         date: {
           dateMath: `${ELASTICSEARCH_DOCS}common-options.html#date-math`,
           dateMathIndexNames: `${ELASTICSEARCH_DOCS}date-math-index-names.html`,
         },
         management: {
-          kibanaSearchSettings: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/advanced-options.html#kibana-search-settings`,
           dashboardSettings: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/advanced-options.html#kibana-dashboard-settings`,
+          indexManagement: `${ELASTICSEARCH_DOCS}index-mgmt.html`,
+          kibanaSearchSettings: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/advanced-options.html#kibana-search-settings`,
           visualizationSettings: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/advanced-options.html#kibana-visualization-settings`,
         },
         ml: {
@@ -271,6 +315,7 @@ export class DocLinksService {
           painlessExecute: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/painless/${DOC_LINK_VERSION}/painless-execute-api.html`,
           painlessExecuteAPIContexts: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/painless/${DOC_LINK_VERSION}/painless-execute-api.html#_contexts`,
           putComponentTemplateMetadata: `${ELASTICSEARCH_DOCS}indices-component-template.html#component-templates-metadata`,
+          putIndexTemplateV1: `${ELASTICSEARCH_DOCS}indices-templates-v1.html`,
           putSnapshotLifecyclePolicy: `${ELASTICSEARCH_DOCS}slm-api-put-policy.html`,
           putWatch: `${ELASTICSEARCH_DOCS}/watcher-api-put-watch.html`,
           updateTransform: `${ELASTICSEARCH_DOCS}update-transform.html`,
@@ -387,6 +432,7 @@ export interface DocLinksStart {
       readonly top_hits: string;
     };
     readonly runtimeFields: {
+      readonly overview: string;
       readonly mapping: string;
     };
     readonly scriptedFields: {
@@ -413,9 +459,10 @@ export interface DocLinksStart {
     };
     readonly query: {
       readonly eql: string;
+      readonly kueryQuerySyntax: string;
       readonly luceneQuerySyntax: string;
+      readonly percolate: string;
       readonly queryDsl: string;
-      readonly kueryQuerySyntax: string;
     };
     readonly date: {
       readonly dateMath: string;
@@ -442,6 +489,7 @@ export interface DocLinksStart {
       painlessExecuteAPIContexts: string;
       putComponentTemplateMetadata: string;
       putSnapshotLifecyclePolicy: string;
+      putIndexTemplateV1: string;
       putWatch: string;
       updateTransform: string;
     }>;

src/core/public/public.api.md

@@ -571,6 +571,7 @@ export interface DocLinksStart {
             readonly top_hits: string;
         };
         readonly runtimeFields: {
+            readonly overview: string;
             readonly mapping: string;
         };
         readonly scriptedFields: {
@@ -597,9 +598,10 @@ export interface DocLinksStart {
         };
         readonly query: {
             readonly eql: string;
+            readonly kueryQuerySyntax: string;
             readonly luceneQuerySyntax: string;
+            readonly percolate: string;
             readonly queryDsl: string;
-            readonly kueryQuerySyntax: string;
         };
         readonly date: {
             readonly dateMath: string;
@@ -626,6 +628,7 @@ export interface DocLinksStart {
             painlessExecuteAPIContexts: string;
             putComponentTemplateMetadata: string;
             putSnapshotLifecyclePolicy: string;
+            putIndexTemplateV1: string;
             putWatch: string;
             updateTransform: string;
         }>;

x-pack/plugins/data_enhanced/public/search/sessions_mgmt/components/main.test.tsx

@@ -57,9 +57,11 @@ describe('Background Search Session Management Main', () => {
 
   describe('renders', () => {
     const docLinks: DocLinksStart = {
-      ELASTIC_WEBSITE_URL: 'boo/',
-      DOC_LINK_VERSION: '#foo',
-      links: {} as any,
+      ELASTIC_WEBSITE_URL: `boo/`,
+      DOC_LINK_VERSION: `#foo`,
+      links: {
+        elasticsearch: { asyncSearch: `mock-url` } as any,
+      } as any,
     };
 
     let main: ReactWrapper;
@@ -93,9 +95,7 @@ describe('Background Search Session Management Main', () => {
     test('documentation link', () => {
       const docLink = main.find('a[href]').first();
       expect(docLink.text()).toBe('Documentation');
-      expect(docLink.prop('href')).toBe(
-        'boo/guide/en/elasticsearch/reference/#foo/async-search-intro.html'
-      );
+      expect(docLink.prop('href')).toBe('mock-url');
     });
 
     test('table is present', () => {

x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/documentation.ts

@@ -8,16 +8,15 @@
 import { DocLinksStart } from 'kibana/public';
 
 export class AsyncSearchIntroDocumentation {
-  private docsBasePath: string = '';
+  private docUrl: string = '';
 
   constructor(docs: DocLinksStart) {
-    const { DOC_LINK_VERSION, ELASTIC_WEBSITE_URL } = docs;
-    const docsBase = `${ELASTIC_WEBSITE_URL}guide/en`;
+    const { links } = docs;
     // TODO: There should be Kibana documentation link about Search Sessions in Kibana
-    this.docsBasePath = `${docsBase}/elasticsearch/reference/${DOC_LINK_VERSION}`;
+    this.docUrl = links.elasticsearch.asyncSearch;
   }
 
   public getElasticsearchDocLink() {
-    return `${this.docsBasePath}/async-search-intro.html`;
+    return `${this.docUrl}`;
   }
 }

x-pack/plugins/index_management/public/application/components/component_templates/lib/documentation.ts

@@ -7,14 +7,11 @@
 
 import { DocLinksStart } from 'src/core/public';
 
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const getDocumentation = ({ ELASTIC_WEBSITE_URL, DOC_LINK_VERSION }: DocLinksStart) => {
-  const docsBase = `${ELASTIC_WEBSITE_URL}guide/en`;
-  const esDocsBase = `${docsBase}/elasticsearch/reference/${DOC_LINK_VERSION}`;
-
+export const getDocumentation = ({ links }: DocLinksStart) => {
+  const esDocsBase = links.elasticsearch.docsBase;
   return {
     esDocsBase,
-    componentTemplates: `${esDocsBase}/indices-component-template.html`,
-    componentTemplatesMetadata: `${esDocsBase}/indices-component-template.html#component-templates-metadata`,
+    componentTemplates: links.apis.putComponentTemplate,
+    componentTemplatesMetadata: links.apis.putComponentTemplateMetadata,
   };
 };