Skip to content

Commit 6cd29f8

Browse files
DosantDosant
committed
wire up links to documentation
1 parent b913f21 commit 6cd29f8

File tree

11 files changed

+37
-4
lines changed

11 files changed

+37
-4
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
readonly links: {
1111
readonly dashboard: {
1212
readonly drilldowns: string;
13+
readonly urlDrilldownTriggerPicker: string;
14+
readonly urlDrilldownTemplateSyntax: string;
15+
readonly urlDrilldownVariables: string;
1316
};
1417
readonly filebeat: {
1518
readonly base: string;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ export interface DocLinksStart
1717
| --- | --- | --- |
1818
| [DOC\_LINK\_VERSION](./kibana-plugin-core-public.doclinksstart.doc_link_version.md) | <code>string</code> | |
1919
| [ELASTIC\_WEBSITE\_URL](./kibana-plugin-core-public.doclinksstart.elastic_website_url.md) | <code>string</code> | |
20-
| [links](./kibana-plugin-core-public.doclinksstart.links.md) | <code>{</code><br/><code> readonly dashboard: {</code><br/><code> readonly drilldowns: string;</code><br/><code> };</code><br/><code> readonly filebeat: {</code><br/><code> readonly base: string;</code><br/><code> readonly installation: string;</code><br/><code> readonly configuration: string;</code><br/><code> readonly elasticsearchOutput: string;</code><br/><code> readonly startup: string;</code><br/><code> readonly exportedFields: string;</code><br/><code> };</code><br/><code> readonly auditbeat: {</code><br/><code> readonly base: string;</code><br/><code> };</code><br/><code> readonly metricbeat: {</code><br/><code> readonly base: string;</code><br/><code> };</code><br/><code> readonly heartbeat: {</code><br/><code> readonly base: string;</code><br/><code> };</code><br/><code> readonly logstash: {</code><br/><code> readonly base: string;</code><br/><code> };</code><br/><code> readonly functionbeat: {</code><br/><code> readonly base: string;</code><br/><code> };</code><br/><code> readonly winlogbeat: {</code><br/><code> readonly base: string;</code><br/><code> };</code><br/><code> readonly aggs: {</code><br/><code> readonly date_histogram: string;</code><br/><code> readonly date_range: string;</code><br/><code> readonly filter: string;</code><br/><code> readonly filters: string;</code><br/><code> readonly geohash_grid: string;</code><br/><code> readonly histogram: string;</code><br/><code> readonly ip_range: string;</code><br/><code> readonly range: string;</code><br/><code> readonly significant_terms: string;</code><br/><code> readonly terms: string;</code><br/><code> readonly avg: string;</code><br/><code> readonly avg_bucket: string;</code><br/><code> readonly max_bucket: string;</code><br/><code> readonly min_bucket: string;</code><br/><code> readonly sum_bucket: string;</code><br/><code> readonly cardinality: string;</code><br/><code> readonly count: string;</code><br/><code> readonly cumulative_sum: string;</code><br/><code> readonly derivative: string;</code><br/><code> readonly geo_bounds: string;</code><br/><code> readonly geo_centroid: string;</code><br/><code> readonly max: string;</code><br/><code> readonly median: string;</code><br/><code> readonly min: string;</code><br/><code> readonly moving_avg: string;</code><br/><code> readonly percentile_ranks: string;</code><br/><code> readonly serial_diff: string;</code><br/><code> readonly std_dev: string;</code><br/><code> readonly sum: string;</code><br/><code> readonly top_hits: string;</code><br/><code> };</code><br/><code> readonly scriptedFields: {</code><br/><code> readonly scriptFields: string;</code><br/><code> readonly scriptAggs: string;</code><br/><code> readonly painless: string;</code><br/><code> readonly painlessApi: string;</code><br/><code> readonly painlessSyntax: string;</code><br/><code> readonly luceneExpressions: string;</code><br/><code> };</code><br/><code> readonly indexPatterns: {</code><br/><code> readonly loadingData: string;</code><br/><code> readonly introduction: string;</code><br/><code> };</code><br/><code> readonly addData: string;</code><br/><code> readonly kibana: string;</code><br/><code> readonly siem: {</code><br/><code> readonly guide: string;</code><br/><code> readonly gettingStarted: string;</code><br/><code> };</code><br/><code> readonly query: {</code><br/><code> readonly luceneQuerySyntax: string;</code><br/><code> readonly queryDsl: string;</code><br/><code> readonly kueryQuerySyntax: string;</code><br/><code> };</code><br/><code> readonly date: {</code><br/><code> readonly dateMath: string;</code><br/><code> };</code><br/><code> readonly management: Record&lt;string, string&gt;;</code><br/><code> readonly visualize: Record&lt;string, string&gt;;</code><br/><code> }</code> | |
20+
| [links](./kibana-plugin-core-public.doclinksstart.links.md) | <code>{</code><br/><code> readonly dashboard: {</code><br/><code> readonly drilldowns: string;</code><br/><code> readonly urlDrilldownTriggerPicker: string;</code><br/><code> readonly urlDrilldownTemplateSyntax: string;</code><br/><code> readonly urlDrilldownVariables: string;</code><br/><code> };</code><br/><code> readonly filebeat: {</code><br/><code> readonly base: string;</code><br/><code> readonly installation: string;</code><br/><code> readonly configuration: string;</code><br/><code> readonly elasticsearchOutput: string;</code><br/><code> readonly startup: string;</code><br/><code> readonly exportedFields: string;</code><br/><code> };</code><br/><code> readonly auditbeat: {</code><br/><code> readonly base: string;</code><br/><code> };</code><br/><code> readonly metricbeat: {</code><br/><code> readonly base: string;</code><br/><code> };</code><br/><code> readonly heartbeat: {</code><br/><code> readonly base: string;</code><br/><code> };</code><br/><code> readonly logstash: {</code><br/><code> readonly base: string;</code><br/><code> };</code><br/><code> readonly functionbeat: {</code><br/><code> readonly base: string;</code><br/><code> };</code><br/><code> readonly winlogbeat: {</code><br/><code> readonly base: string;</code><br/><code> };</code><br/><code> readonly aggs: {</code><br/><code> readonly date_histogram: string;</code><br/><code> readonly date_range: string;</code><br/><code> readonly filter: string;</code><br/><code> readonly filters: string;</code><br/><code> readonly geohash_grid: string;</code><br/><code> readonly histogram: string;</code><br/><code> readonly ip_range: string;</code><br/><code> readonly range: string;</code><br/><code> readonly significant_terms: string;</code><br/><code> readonly terms: string;</code><br/><code> readonly avg: string;</code><br/><code> readonly avg_bucket: string;</code><br/><code> readonly max_bucket: string;</code><br/><code> readonly min_bucket: string;</code><br/><code> readonly sum_bucket: string;</code><br/><code> readonly cardinality: string;</code><br/><code> readonly count: string;</code><br/><code> readonly cumulative_sum: string;</code><br/><code> readonly derivative: string;</code><br/><code> readonly geo_bounds: string;</code><br/><code> readonly geo_centroid: string;</code><br/><code> readonly max: string;</code><br/><code> readonly median: string;</code><br/><code> readonly min: string;</code><br/><code> readonly moving_avg: string;</code><br/><code> readonly percentile_ranks: string;</code><br/><code> readonly serial_diff: string;</code><br/><code> readonly std_dev: string;</code><br/><code> readonly sum: string;</code><br/><code> readonly top_hits: string;</code><br/><code> };</code><br/><code> readonly scriptedFields: {</code><br/><code> readonly scriptFields: string;</code><br/><code> readonly scriptAggs: string;</code><br/><code> readonly painless: string;</code><br/><code> readonly painlessApi: string;</code><br/><code> readonly painlessSyntax: string;</code><br/><code> readonly luceneExpressions: string;</code><br/><code> };</code><br/><code> readonly indexPatterns: {</code><br/><code> readonly loadingData: string;</code><br/><code> readonly introduction: string;</code><br/><code> };</code><br/><code> readonly addData: string;</code><br/><code> readonly kibana: string;</code><br/><code> readonly siem: {</code><br/><code> readonly guide: string;</code><br/><code> readonly gettingStarted: string;</code><br/><code> };</code><br/><code> readonly query: {</code><br/><code> readonly luceneQuerySyntax: string;</code><br/><code> readonly queryDsl: string;</code><br/><code> readonly kueryQuerySyntax: string;</code><br/><code> };</code><br/><code> readonly date: {</code><br/><code> readonly dateMath: string;</code><br/><code> };</code><br/><code> readonly management: Record&lt;string, string&gt;;</code><br/><code> readonly visualize: Record&lt;string, string&gt;;</code><br/><code> }</code> | |
2121

‎src/core/public/doc_links/doc_links_service.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ export class DocLinksService {
3838
links: {
3939
dashboard: {
4040
drilldowns: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/drilldowns.html`,
41+
drilldownsTriggerPicker: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/url-drilldown.html#trigger-picker`,
42+
urlDrilldownTemplateSyntax: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/url-drilldown.html#templating`,
43+
urlDrilldownVariables: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/url-drilldown.html#variables`,
4144
},
4245
filebeat: {
4346
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}`,
@@ -143,6 +146,9 @@ export interface DocLinksStart {
143146
readonly links: {
144147
readonly dashboard: {
145148
readonly drilldowns: string;
149+
readonly drilldownsTriggerPicker: string;
150+
readonly urlDrilldownTemplateSyntax: string;
151+
readonly urlDrilldownVariables: string;
146152
};
147153
readonly filebeat: {
148154
readonly base: string;

‎src/core/public/public.api.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -490,6 +490,9 @@ export interface DocLinksStart {
490490
readonly links: {
491491
readonly dashboard: {
492492
readonly drilldowns: string;
493+
readonly urlDrilldownTriggerPicker: string;
494+
readonly urlDrilldownTemplateSyntax: string;
495+
readonly urlDrilldownVariables: string;
493496
};
494497
readonly filebeat: {
495498
readonly base: string;

‎x-pack/plugins/embeddable_enhanced/public/drilldowns/url_drilldown/url_drilldown.test.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ describe('UrlDrilldown', () => {
5454
getGlobalScope: () => ({ kibanaUrl: 'http://localhost:5601/' }),
5555
getOpenModal: () => Promise.resolve(coreMock.createStart().overlays.openModal),
5656
getSyntaxHelpDocsLink: () => 'http://localhost:5601/docs',
57+
getVariablesHelpDocsLink: () => 'http://localhost:5601/docs',
5758
navigateToUrl: mockNavigateToUrl,
5859
});
5960

‎x-pack/plugins/embeddable_enhanced/public/drilldowns/url_drilldown/url_drilldown.tsx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ interface UrlDrilldownDeps {
3131
navigateToUrl: (url: string) => Promise<void>;
3232
getOpenModal: () => Promise<OverlayStart['openModal']>;
3333
getSyntaxHelpDocsLink: () => string;
34+
getVariablesHelpDocsLink: () => string;
3435
}
3536

3637
export type ActionContext = ChartActionContext;
@@ -74,6 +75,7 @@ export class UrlDrilldown implements Drilldown<Config, UrlTrigger, ActionFactory
7475
onConfig={onConfig}
7576
scope={scope}
7677
syntaxHelpDocsLink={this.deps.getSyntaxHelpDocsLink()}
78+
variablesHelpDocsLink={this.deps.getVariablesHelpDocsLink()}
7779
/>
7880
);
7981
};

‎x-pack/plugins/embeddable_enhanced/public/plugin.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,10 @@ export class EmbeddableEnhancedPlugin
7575
navigateToUrl: (url: string) =>
7676
core.getStartServices().then(([{ application }]) => application.navigateToUrl(url)),
7777
getOpenModal: () => core.getStartServices().then(([{ overlays }]) => overlays.openModal),
78-
getSyntaxHelpDocsLink: () => startServices().core.docLinks.links.dashboard.drilldowns, // TODO: replace with docs https://github.com/elastic/kibana/issues/69414
78+
getSyntaxHelpDocsLink: () =>
79+
startServices().core.docLinks.links.dashboard.urlDrilldownTemplateSyntax,
80+
getVariablesHelpDocsLink: () =>
81+
startServices().core.docLinks.links.dashboard.urlDrilldownVariables,
7982
})
8083
);
8184

‎x-pack/plugins/ui_actions_enhanced/public/drilldowns/components/connected_flyout_manage_drilldowns/connected_flyout_manage_drilldowns.tsx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,15 @@ export function createFlyoutManageDrilldowns({
6464
storage,
6565
toastService,
6666
docsLink,
67+
triggerPickerDocsLink,
6768
getTrigger,
6869
}: {
6970
actionFactories: ActionFactory[];
7071
getTrigger: (triggerId: TriggerId) => Trigger;
7172
storage: IStorageWrapper;
7273
toastService: ToastsStart;
7374
docsLink?: string;
75+
triggerPickerDocsLink?: string;
7476
}) {
7577
const allActionFactoriesById = allActionFactories.reduce((acc, next) => {
7678
acc[next.id] = next;
@@ -161,6 +163,7 @@ export function createFlyoutManageDrilldowns({
161163
return (
162164
<FlyoutDrilldownWizard
163165
docsLink={docsLink}
166+
triggerPickerDocsLink={triggerPickerDocsLink}
164167
showWelcomeMessage={shouldShowWelcomeMessage}
165168
onWelcomeHideClick={onHideWelcomeMessage}
166169
drilldownActionFactories={actionFactories}

‎x-pack/plugins/ui_actions_enhanced/public/drilldowns/components/flyout_drilldown_wizard/flyout_drilldown_wizard.tsx‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,16 @@ export interface FlyoutDrilldownWizardProps<
4646

4747
actionFactoryPlaceContext?: ActionFactoryPlaceContext<ActionFactoryContext>;
4848

49+
/**
50+
* General overview of drilldowns
51+
*/
4952
docsLink?: string;
5053

54+
/**
55+
* Link that explains different triggers
56+
*/
57+
triggerPickerDocsLink?: string;
58+
5159
getTrigger: (triggerId: TriggerId) => Trigger;
5260

5361
/**
@@ -145,6 +153,7 @@ export function FlyoutDrilldownWizard<CurrentActionConfig extends object = objec
145153
drilldownActionFactories,
146154
actionFactoryPlaceContext,
147155
docsLink,
156+
triggerPickerDocsLink,
148157
getTrigger,
149158
supportedTriggers,
150159
}: FlyoutDrilldownWizardProps<CurrentActionConfig>) {
@@ -217,7 +226,7 @@ export function FlyoutDrilldownWizard<CurrentActionConfig extends object = objec
217226
onSelectedTriggersChange={setSelectedTriggers}
218227
supportedTriggers={supportedTriggers}
219228
getTriggerInfo={getTrigger}
220-
triggerPickerDocsLink={docsLink}
229+
triggerPickerDocsLink={triggerPickerDocsLink}
221230
/>
222231
{mode === 'edit' && (
223232
<>

‎x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/components/url_drilldown_collect_config/url_drilldown_collect_config.tsx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,15 @@ export interface UrlDrilldownCollectConfig {
4141
onConfig: (newConfig: UrlDrilldownConfig) => void;
4242
scope: UrlDrilldownScope;
4343
syntaxHelpDocsLink?: string;
44+
variablesHelpDocsLink?: string;
4445
}
4546

4647
export const UrlDrilldownCollectConfig: React.FC<UrlDrilldownCollectConfig> = ({
4748
config,
4849
onConfig,
4950
scope,
5051
syntaxHelpDocsLink,
52+
variablesHelpDocsLink,
5153
}) => {
5254
const textAreaRef = useRef<HTMLTextAreaElement>(null);
5355
const urlTemplate = config.url.template ?? '';
@@ -95,7 +97,7 @@ export const UrlDrilldownCollectConfig: React.FC<UrlDrilldownCollectConfig> = ({
9597
labelAppend={
9698
<AddVariableButton
9799
variables={scopeVariables}
98-
variablesHelpLink={syntaxHelpDocsLink}
100+
variablesHelpLink={variablesHelpDocsLink}
99101
onSelect={(variable: string) => {
100102
if (textAreaRef.current) {
101103
updateUrlTemplate(

0 commit comments

Comments
 (0)