Skip to content

Commit 7b22344

Browse files
Tommy Markleykavilla
Tommy Markley
authored and
kavilla
committed
Fix beta doc links, truncated help menu label (#382)
* Fix dashboards documentation and DQL links, expand help menu width so label isn't truncated Signed-off-by: Tommy Markley <markleyt@amazon.com> * Remove kibana references from doc links, fix aggregation links Signed-off-by: Tommy Markley <markleyt@amazon.com>
1 parent 5566f22 commit 7b22344

File tree

4 files changed

+52
-51
lines changed

4 files changed

+52
-51
lines changed

‎src/core/public/chrome/ui/header/header_help_menu.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ export type ChromeHelpExtensionMenuDocumentationLink = EuiButtonEmptyProps & {
9191
linkType: 'documentation';
9292
/**
9393
* URL to documentation page.
94-
* i.e. `${OPENSEARARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html`,
94+
* i.e. `${OPENSEARCH_DOCS}${appName}`,
9595
*/
9696
href: string;
9797
};
@@ -365,7 +365,7 @@ class HeaderHelpMenuUI extends Component<Props, State> {
365365
</EuiFlexGroup>
366366
</EuiPopoverTitle>
367367

368-
<div style={{ maxWidth: 240 }}>
368+
<div style={{ maxWidth: 270 }}>
369369
{defaultContent}
370370
{defaultContent && customContent && <EuiHorizontalRule margin="m" />}
371371
{customContent}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ describe('DocLinksService#start()', () => {
4141
const api = service.start({ injectedMetadata });
4242
expect(api.DOC_LINK_VERSION).toEqual('test-branch');
4343
expect(api.links.opensearchDashboards).toEqual(
44-
'https://www.opensearch.org/guide/en/kibana/test-branch/index.html'
44+
'https://docs-beta.opensearch.org/docs/opensearch-dashboards/'
4545
);
4646
});
4747
});

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

Lines changed: 48 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,18 @@ export class DocLinksService {
4343
public start({ injectedMetadata }: StartDeps): DocLinksStart {
4444
const DOC_LINK_VERSION = injectedMetadata.getOpenSearchDashboardsBranch();
4545
const OPENSEARCH_WEBSITE_URL = 'https://www.opensearch.org/';
46-
const OPENSEARCH_DOCS = `${OPENSEARCH_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}/`;
46+
const OPENSEARCH_DOCS = `https://docs-beta.opensearch.org/docs/opensearch/`;
47+
const OPENSEARCH_DASHBOARDS_DOCS = `https://docs-beta.opensearch.org/docs/opensearch-dashboards/`;
4748

4849
return deepFreeze({
4950
DOC_LINK_VERSION,
5051
OPENSEARCH_WEBSITE_URL,
5152
links: {
5253
dashboard: {
53-
drilldowns: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/drilldowns.html`,
54-
drilldownsTriggerPicker: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/drilldowns.html#url-drilldowns`,
55-
urlDrilldownTemplateSyntax: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/url_templating-language.html`,
56-
urlDrilldownVariables: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/url_templating-language.html#url-template-variables`,
54+
drilldowns: `${OPENSEARCH_WEBSITE_URL}guide/en/opensearch/${DOC_LINK_VERSION}/drilldowns.html`,
55+
drilldownsTriggerPicker: `${OPENSEARCH_WEBSITE_URL}guide/en/opensearch/${DOC_LINK_VERSION}/drilldowns.html#url-drilldowns`,
56+
urlDrilldownTemplateSyntax: `${OPENSEARCH_WEBSITE_URL}guide/en/opensearch/${DOC_LINK_VERSION}/url_templating-language.html`,
57+
urlDrilldownVariables: `${OPENSEARCH_WEBSITE_URL}guide/en/opensearch/${DOC_LINK_VERSION}/url_templating-language.html#url-template-variables`,
5758
},
5859
filebeat: {
5960
base: `${OPENSEARCH_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}`,
@@ -82,72 +83,72 @@ export class DocLinksService {
8283
base: `${OPENSEARCH_WEBSITE_URL}guide/en/beats/winlogbeat/${DOC_LINK_VERSION}`,
8384
},
8485
aggs: {
85-
date_histogram: `${OPENSEARCH_DOCS}search-aggregations-bucket-datehistogram-aggregation.html`,
86-
date_range: `${OPENSEARCH_DOCS}search-aggregations-bucket-daterange-aggregation.html`,
87-
filter: `${OPENSEARCH_DOCS}search-aggregations-bucket-filter-aggregation.html`,
88-
filters: `${OPENSEARCH_DOCS}search-aggregations-bucket-filters-aggregation.html`,
89-
geohash_grid: `${OPENSEARCH_DOCS}search-aggregations-bucket-geohashgrid-aggregation.html`,
90-
histogram: `${OPENSEARCH_DOCS}search-aggregations-bucket-histogram-aggregation.html`,
91-
ip_range: `${OPENSEARCH_DOCS}search-aggregations-bucket-iprange-aggregation.html`,
92-
range: `${OPENSEARCH_DOCS}search-aggregations-bucket-range-aggregation.html`,
93-
significant_terms: `${OPENSEARCH_DOCS}search-aggregations-bucket-significantterms-aggregation.html`,
94-
terms: `${OPENSEARCH_DOCS}search-aggregations-bucket-terms-aggregation.html`,
95-
avg: `${OPENSEARCH_DOCS}search-aggregations-metrics-avg-aggregation.html`,
96-
avg_bucket: `${OPENSEARCH_DOCS}search-aggregations-pipeline-avg-bucket-aggregation.html`,
97-
max_bucket: `${OPENSEARCH_DOCS}search-aggregations-pipeline-max-bucket-aggregation.html`,
98-
min_bucket: `${OPENSEARCH_DOCS}search-aggregations-pipeline-min-bucket-aggregation.html`,
99-
sum_bucket: `${OPENSEARCH_DOCS}search-aggregations-pipeline-sum-bucket-aggregation.html`,
100-
cardinality: `${OPENSEARCH_DOCS}search-aggregations-metrics-cardinality-aggregation.html`,
101-
count: `${OPENSEARCH_DOCS}search-aggregations-metrics-valuecount-aggregation.html`,
102-
cumulative_sum: `${OPENSEARCH_DOCS}search-aggregations-metrics-sum-aggregation.html`,
103-
derivative: `${OPENSEARCH_DOCS}search-aggregations-pipeline-derivative-aggregation.html`,
104-
geo_bounds: `${OPENSEARCH_DOCS}search-aggregations-metrics-geobounds-aggregation.html`,
105-
geo_centroid: `${OPENSEARCH_DOCS}search-aggregations-metrics-geocentroid-aggregation.html`,
106-
max: `${OPENSEARCH_DOCS}search-aggregations-metrics-max-aggregation.html`,
107-
median: `${OPENSEARCH_DOCS}search-aggregations-metrics-percentile-aggregation.html`,
108-
min: `${OPENSEARCH_DOCS}search-aggregations-metrics-min-aggregation.html`,
109-
moving_avg: `${OPENSEARCH_DOCS}search-aggregations-pipeline-movavg-aggregation.html`,
110-
percentile_ranks: `${OPENSEARCH_DOCS}search-aggregations-metrics-percentile-rank-aggregation.html`,
111-
serial_diff: `${OPENSEARCH_DOCS}search-aggregations-pipeline-serialdiff-aggregation.html`,
112-
std_dev: `${OPENSEARCH_DOCS}search-aggregations-metrics-extendedstats-aggregation.html`,
113-
sum: `${OPENSEARCH_DOCS}search-aggregations-metrics-sum-aggregation.html`,
114-
top_hits: `${OPENSEARCH_DOCS}search-aggregations-metrics-top-hits-aggregation.html`,
86+
date_histogram: `${OPENSEARCH_DOCS}bucket-agg/#histogram-date_histogram`,
87+
date_range: `${OPENSEARCH_DOCS}bucket-agg/#range-date_range-ip_range`,
88+
filter: `${OPENSEARCH_DOCS}bucket-agg/#filter-filters`,
89+
filters: `${OPENSEARCH_DOCS}bucket-agg/#filter-filters`,
90+
geohash_grid: `${OPENSEARCH_DOCS}bucket-agg/#geo_distance-geohash_grid`,
91+
histogram: `${OPENSEARCH_DOCS}bucket-agg/#histogram-date_histogram`,
92+
ip_range: `${OPENSEARCH_DOCS}bucket-agg/#range-date_range-ip_range`,
93+
range: `${OPENSEARCH_DOCS}bucket-agg/#range-date_range-ip_range`,
94+
significant_terms: `${OPENSEARCH_DOCS}bucket-agg/#significant_terms-significant_text`,
95+
terms: `${OPENSEARCH_DOCS}bucket-agg/#terms`,
96+
avg: `${OPENSEARCH_DOCS}metric-agg/#sum-min-max-avg`,
97+
avg_bucket: `${OPENSEARCH_DOCS}pipeline-agg/#avg_bucket-sum_bucket-min_bucket-max_bucket`,
98+
max_bucket: `${OPENSEARCH_DOCS}pipeline-agg/#avg_bucket-sum_bucket-min_bucket-max_bucket`,
99+
min_bucket: `${OPENSEARCH_DOCS}pipeline-agg/#avg_bucket-sum_bucket-min_bucket-max_bucket`,
100+
sum_bucket: `${OPENSEARCH_DOCS}pipeline-agg/#avg_bucket-sum_bucket-min_bucket-max_bucket`,
101+
cardinality: `${OPENSEARCH_DOCS}metric-agg/#cardinality`,
102+
count: `${OPENSEARCH_DOCS}metric-agg/#value_count`,
103+
cumulative_sum: `${OPENSEARCH_DOCS}pipeline-agg/#cumulative_sum`,
104+
derivative: `${OPENSEARCH_DOCS}pipeline-agg/#derivative`,
105+
geo_bounds: `${OPENSEARCH_DOCS}metric-agg/#geo_bound`,
106+
geo_centroid: `${OPENSEARCH_DOCS}metric-agg/#geo_bound`,
107+
max: `${OPENSEARCH_DOCS}metric-agg/#sum-min-max-avg`,
108+
median: `${OPENSEARCH_DOCS}metric-agg/#sum-min-max-avg`,
109+
min: `${OPENSEARCH_DOCS}metric-agg/#sum-min-max-avg`,
110+
moving_avg: `${OPENSEARCH_DOCS}pipeline-agg/#moving_avg`,
111+
percentile_ranks: `${OPENSEARCH_DOCS}metric-agg/#percentile-percentile_ranks`,
112+
serial_diff: `${OPENSEARCH_DOCS}pipeline-agg/#serial_diff`,
113+
std_dev: `${OPENSEARCH_DOCS}metric-agg/#stats-extended_stats-matrix_stats`,
114+
sum: `${OPENSEARCH_DOCS}metric-agg/#sum-min-max-avg`,
115+
top_hits: `${OPENSEARCH_DOCS}metric-agg/#top_hits`,
115116
},
116117
scriptedFields: {
117118
scriptFields: `${OPENSEARCH_DOCS}search-request-script-fields.html`,
118-
scriptAggs: `${OPENSEARCH_DOCS}search-aggregations.html#_values_source`,
119+
scriptAggs: `${OPENSEARCH_DOCS}metric-agg/#scripted_metric`,
119120
painless: `${OPENSEARCH_DOCS}modules-scripting-painless.html`,
120121
painlessApi: `${OPENSEARCH_WEBSITE_URL}guide/en/elasticsearch/painless/${DOC_LINK_VERSION}/painless-api-reference.html`,
121122
painlessSyntax: `${OPENSEARCH_DOCS}modules-scripting-painless-syntax.html`,
122123
luceneExpressions: `${OPENSEARCH_DOCS}modules-scripting-expression.html`,
123124
},
124125
indexPatterns: {
125-
loadingData: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/tutorial-load-dataset.html`,
126-
introduction: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/index-patterns.html`,
126+
loadingData: `${OPENSEARCH_WEBSITE_URL}guide/en/opensearch/${DOC_LINK_VERSION}/tutorial-load-dataset.html`,
127+
introduction: `${OPENSEARCH_WEBSITE_URL}guide/en/opensearch/${DOC_LINK_VERSION}/index-patterns.html`,
127128
},
128-
addData: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/connect-to-elasticsearch.html`,
129-
opensearchDashboards: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/index.html`,
129+
addData: `${OPENSEARCH_WEBSITE_URL}guide/en/opensearch/${DOC_LINK_VERSION}/connect-to-elasticsearch.html`,
130+
opensearchDashboards: `${OPENSEARCH_DASHBOARDS_DOCS}`,
130131
siem: {
131132
guide: `${OPENSEARCH_WEBSITE_URL}guide/en/security/${DOC_LINK_VERSION}/index.html`,
132133
gettingStarted: `${OPENSEARCH_WEBSITE_URL}guide/en/security/${DOC_LINK_VERSION}/index.html`,
133134
},
134135
query: {
135136
eql: `${OPENSEARCH_DOCS}eql.html`,
136137
luceneQuerySyntax: `${OPENSEARCH_DOCS}query-dsl-query-string-query.html#query-string-syntax`,
137-
queryDsl: `${OPENSEARCH_DOCS}query-dsl.html`,
138-
kueryQuerySyntax: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/kuery-query.html`,
138+
queryDsl: `${OPENSEARCH_DOCS}query-dsl`,
139+
kueryQuerySyntax: `${OPENSEARCH_DOCS}query-dsl`,
139140
},
140141
date: {
141142
dateMath: `${OPENSEARCH_DOCS}common-options.html#date-math`,
142143
},
143144
management: {
144-
opensearchDashboardsGeneralSettings: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/advanced-options.html#kibana-general-settings`,
145-
opensearchDashboardsSearchSettings: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/advanced-options.html#kibana-search-settings`,
146-
dashboardSettings: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/advanced-options.html#kibana-dashboard-settings`,
145+
opensearchDashboardsGeneralSettings: `${OPENSEARCH_WEBSITE_URL}guide/en/opensearch/${DOC_LINK_VERSION}/advanced-options.html#opensearch-general-settings`,
146+
opensearchDashboardsSearchSettings: `${OPENSEARCH_WEBSITE_URL}guide/en/opensearch/${DOC_LINK_VERSION}/advanced-options.html#opensearch-search-settings`,
147+
dashboardSettings: `${OPENSEARCH_WEBSITE_URL}guide/en/opensearch/${DOC_LINK_VERSION}/advanced-options.html#opensearch-dashboard-settings`,
147148
},
148149
visualize: {
149-
guide: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/dashboard.html`,
150-
timelineDeprecation: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/dashboard.html#timeline-deprecation`,
150+
guide: `${OPENSEARCH_WEBSITE_URL}guide/en/opensearch/${DOC_LINK_VERSION}/dashboard.html`,
151+
timelineDeprecation: `${OPENSEARCH_WEBSITE_URL}guide/en/opensearch/${DOC_LINK_VERSION}/dashboard.html#timeline-deprecation`,
151152
},
152153
},
153154
});

‎src/plugins/index_pattern_management/public/components/index_pattern_table/empty_state/__snapshots__/empty_state.test.tsx.snap‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)