github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 01:13:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add URLs from ui_settings.ts to doc link service (#122408)

Browse source
This commit is contained in:
Lisa Cawley 2022-01-10 17:12:22 -08:00 • committed by GitHub
parent 526f2fd545
commit 55b8c80a87
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 41 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -193,7 +193,10 @@ readonly links: {
readonly runtimeFields: string;
};
readonly addData: string;
readonly kibana: string;
readonly kibana: {
readonly guide: string;
readonly autocompleteSuggestions: string;
};
readonly upgradeAssistant: {
readonly overview: string;
readonly batchReindex: string;
@ -218,6 +221,7 @@ readonly links: {
readonly query: {
readonly eql: string;
readonly kueryQuerySyntax: string;
readonly luceneQuery: string;
readonly luceneQuerySyntax: string;
readonly percolate: string;
readonly queryDsl: string;
@ -246,6 +250,7 @@ readonly links: {
cronExpressions: string;
executeWatchActionModes: string;
indexExists: string;
multiSearch: string;
openIndex: string;
putComponentTemplate: string;
painlessExecute: string;
@ -254,8 +259,10 @@ readonly links: {
putSnapshotLifecyclePolicy: string;
putIndexTemplateV1: string;
putWatch: string;
searchPreference: string;
simulatePipeline: string;
timeUnits: string;
unfreezeIndex: string;
updateTransform: string;
}>;
readonly observability: Readonly<{

2
docs/development/core/public/kibana-plugin-core-public.doclinksstart.md
View file

File diff suppressed because one or more lines are too long

2
src/core/public/chrome/chrome_service.tsx
View file

@ -212,7 +212,7 @@ export class ChromeService {
breadcrumbs$={breadcrumbs$.pipe(takeUntil(this.stop$))}
breadcrumbsAppendExtension$={breadcrumbsAppendExtension$.pipe(takeUntil(this.stop$))}
customNavLink$={customNavLink$.pipe(takeUntil(this.stop$))}
kibanaDocLink={docLinks.links.kibana}
kibanaDocLink={docLinks.links.kibana.guide}
forceAppSwitcherNavigation$={navLinks.getForceAppSwitcherNavigation$()}
helpExtension$={helpExtension$.pipe(takeUntil(this.stop$))}
helpSupportUrl$={helpSupportUrl$.pipe(takeUntil(this.stop$))}

2
src/core/public/doc_links/doc_links_service.test.ts
View file

@ -16,7 +16,7 @@ describe('DocLinksService#start()', () => {
const service = new DocLinksService();
const api = service.start({ injectedMetadata });
expect(api.DOC_LINK_VERSION).toEqual('test-branch');
expect(api.links.kibana).toEqual(
expect(api.links.kibana.guide).toEqual(
'https://www.elastic.co/guide/en/kibana/test-branch/index.html'
);
});

20
src/core/public/doc_links/doc_links_service.ts
View file

@ -222,7 +222,10 @@ export class DocLinksService {
runtimeFields: `${KIBANA_DOCS}managing-data-views.html#runtime-fields`,
},
addData: `${KIBANA_DOCS}connect-to-elasticsearch.html`,
kibana: `${KIBANA_DOCS}index.html`,
kibana: {
guide: `${KIBANA_DOCS}index.html`,
autocompleteSuggestions: `${KIBANA_DOCS}kibana-concepts-analysts.html#autocomplete-suggestions`,
},
upgradeAssistant: {
overview: `${KIBANA_DOCS}upgrade-assistant.html`,
batchReindex: `${KIBANA_DOCS}batch-start-resume-reindex.html`,
@ -272,6 +275,7 @@ export class DocLinksService {
mappingJoinFieldsPerformance: `${ELASTICSEARCH_DOCS}parent-join.html#_parent_join_and_performance`,
mappingMeta: `${ELASTICSEARCH_DOCS}mapping-field-meta.html`,
mappingMetaFields: `${ELASTICSEARCH_DOCS}mapping-meta-field.html`,
mappingMultifields: `${ELASTICSEARCH_DOCS}multi-fields.html`,
mappingNormalizer: `${ELASTICSEARCH_DOCS}normalizer.html`,
mappingNorms: `${ELASTICSEARCH_DOCS}norms.html`,
mappingNullValue: `${ELASTICSEARCH_DOCS}null-value.html`,
@ -295,6 +299,7 @@ export class DocLinksService {
remoteClusersProxySettings: `${ELASTICSEARCH_DOCS}remote-clusters-settings.html#remote-cluster-proxy-settings`,
scriptParameters: `${ELASTICSEARCH_DOCS}modules-scripting-using.html#prefer-params`,
shardAllocationSettings: `${ELASTICSEARCH_DOCS}modules-cluster.html#cluster-shard-allocation-settings`,
sortSearch: `${ELASTICSEARCH_DOCS}sort-search-results.html`,
transportSettings: `${ELASTICSEARCH_DOCS}modules-network.html#common-network-settings`,
typesRemoval: `${ELASTICSEARCH_DOCS}removal-of-types.html`,
setupUpgrade: `${ELASTICSEARCH_DOCS}setup-upgrade.html`,
@ -317,6 +322,7 @@ export class DocLinksService {
query: {
eql: `${ELASTICSEARCH_DOCS}eql.html`,
kueryQuerySyntax: `${KIBANA_DOCS}kuery-query.html`,
luceneQuery: `${ELASTICSEARCH_DOCS}query-dsl-query-string-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`,
@ -472,6 +478,7 @@ export class DocLinksService {
cronExpressions: `${ELASTICSEARCH_DOCS}cron-expressions.html`,
executeWatchActionModes: `${ELASTICSEARCH_DOCS}watcher-api-execute-watch.html#watcher-api-execute-watch-action-mode`,
indexExists: `${ELASTICSEARCH_DOCS}indices-exists.html`,
multiSearch: `${ELASTICSEARCH_DOCS}search-multi-search.html`,
openIndex: `${ELASTICSEARCH_DOCS}indices-open-close.html`,
putComponentTemplate: `${ELASTICSEARCH_DOCS}indices-component-template.html`,
painlessExecute: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/painless/${DOC_LINK_VERSION}/painless-execute-api.html`,
@ -481,8 +488,10 @@ export class DocLinksService {
putIndexTemplateV1: `${ELASTICSEARCH_DOCS}indices-templates-v1.html`,
putSnapshotLifecyclePolicy: `${ELASTICSEARCH_DOCS}slm-api-put-policy.html`,
putWatch: `${ELASTICSEARCH_DOCS}watcher-api-put-watch.html`,
searchPreference: `${ELASTICSEARCH_DOCS}search-search.html#search-preference`,
simulatePipeline: `${ELASTICSEARCH_DOCS}simulate-pipeline-api.html`,
timeUnits: `${ELASTICSEARCH_DOCS}api-conventions.html#time-units`,
unfreezeIndex: `${ELASTICSEARCH_DOCS}unfreeze-index-api.html`,
updateTransform: `${ELASTICSEARCH_DOCS}update-transform.html`,
},
plugins: {
@ -783,7 +792,10 @@ export interface DocLinksStart {
readonly runtimeFields: string;
};
readonly addData: string;
readonly kibana: string;
readonly kibana: {
readonly guide: string;
readonly autocompleteSuggestions: string;
};
readonly upgradeAssistant: {
readonly overview: string;
readonly batchReindex: string;
@ -808,6 +820,7 @@ export interface DocLinksStart {
readonly query: {
readonly eql: string;
readonly kueryQuerySyntax: string;
readonly luceneQuery: string;
readonly luceneQuerySyntax: string;
readonly percolate: string;
readonly queryDsl: string;
@ -836,6 +849,7 @@ export interface DocLinksStart {
cronExpressions: string;
executeWatchActionModes: string;
indexExists: string;
multiSearch: string;
openIndex: string;
putComponentTemplate: string;
painlessExecute: string;
@ -844,8 +858,10 @@ export interface DocLinksStart {
putSnapshotLifecyclePolicy: string;
putIndexTemplateV1: string;
putWatch: string;
searchPreference: string;
simulatePipeline: string;
timeUnits: string;
unfreezeIndex: string;
updateTransform: string;
}>;
readonly observability: Readonly<{

9
src/core/public/public.api.md
View file

@ -676,7 +676,10 @@ export interface DocLinksStart {
readonly runtimeFields: string;
};
readonly addData: string;
readonly kibana: string;
readonly kibana: {
readonly guide: string;
readonly autocompleteSuggestions: string;
};
readonly upgradeAssistant: {
readonly overview: string;
readonly batchReindex: string;
@ -701,6 +704,7 @@ export interface DocLinksStart {
readonly query: {
readonly eql: string;
readonly kueryQuerySyntax: string;
readonly luceneQuery: string;
readonly luceneQuerySyntax: string;
readonly percolate: string;
readonly queryDsl: string;
@ -729,6 +733,7 @@ export interface DocLinksStart {
cronExpressions: string;
executeWatchActionModes: string;
indexExists: string;
multiSearch: string;
openIndex: string;
putComponentTemplate: string;
painlessExecute: string;
@ -737,8 +742,10 @@ export interface DocLinksStart {
putSnapshotLifecyclePolicy: string;
putIndexTemplateV1: string;
putWatch: string;
searchPreference: string;
simulatePipeline: string;
timeUnits: string;
unfreezeIndex: string;
updateTransform: string;
}>;
readonly observability: Readonly<{

4
src/plugins/kibana_overview/public/components/overview/overview.test.mocks.ts
View file

@ -23,7 +23,9 @@ jest.doMock('../../../../../../src/plugins/kibana_react/public', () => ({
uiSettings: { get: jest.fn() },
docLinks: {
links: {
kibana: 'kibana_docs_url',
kibana: {
guide: 'kibana_docs_url',
},
},
},
},

2
src/plugins/kibana_overview/public/components/overview/overview.tsx
View file

@ -101,7 +101,7 @@ export const Overview: FC<Props> = ({ newsFetchResult, solutions, features }) =>
}),
},
},
docsLink: docLinks.links.kibana,
docsLink: docLinks.links.kibana.guide,
};
// Show card for console if none of the manage data plugins are available, most likely in OSS