Skip to content

Update Elasticsearch URLs in doc link service #219656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lcawl merged 14 commits into from
May 7, 2025
Merged

Update Elasticsearch URLs in doc link service #219656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d47b999
Update elasticsearch URLs in kibana link service
lcawl Apr 29, 2025
fc9f0f7
Use new Elasticsearch URLs in doc link service
lcawl Apr 30, 2025
664f64c
Merge branch 'main' into es-links
lcawl Apr 30, 2025
83e627d
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Apr 30, 2025
1ceeafc
Fix jest tests in index_details_page.test.tsx
lcawl Apr 30, 2025
7b155c0
Merge branch 'main' into es-links
lcawl Apr 30, 2025
4f30c5f
fix expect
jloleysens May 1, 2025
635dddd
update link expectation
jloleysens May 1, 2025
033617d
Merge branch 'main' into es-links
jloleysens May 1, 2025
3931746
Merge branch 'main' into es-links
lcawl May 2, 2025
101de5f
Merge branch 'main' into es-links
lcawl May 5, 2025
04acb1b
Merge branch 'main' into es-links
lcawl May 5, 2025
08a4277
Merge branch 'main' into es-links
lcawl May 6, 2025
7431a52
update expects based on links
jloleysens May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
376 changes: 192 additions & 184 deletions src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions src/platform/plugins/shared/data/server/ui_settings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,8 +271,7 @@ export function getUiSettings(
},
[UI_SETTINGS.SEARCH_INCLUDE_FROZEN]: {
name: 'Search in frozen indices',
description: `Will include <a href=${docLinks.links.elasticsearch.frozenIndices}
target="_blank" rel="noopener">frozen indices</a> in results if enabled. Searching through frozen indices
description: `Will include frozen indices in results if enabled. Searching through frozen indices
Copy link
Copy Markdown
Contributor

@davismcphee davismcphee May 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this will be removed soon anyway, but I'm guessing we wouldn't want to keep a link to the old docs until then, would we?

Copy link
Copy Markdown
Contributor Author

@lcawl lcawl May 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, if we need to keep a URL we'd have to point it to one of the V8 doc pages.

Copy link
Copy Markdown
Contributor

@davismcphee davismcphee May 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for confirming. I think we're good to remove it since we don't want to promote it, and the setting is going away soon anyway. cc @lukasolson for awareness just in case you have thoughts.

might increase the search time.`,
value: false,
deprecation: {
Expand Down
8 changes: 2 additions & 6 deletions ...dex_management/__jest__/client_integration/index_details_page/index_details_page.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -643,9 +643,7 @@ describe('<IndexDetailsPage />', () => {
it('sets the docs link href from the documentation service', async () => {
const docsLinkHref = testBed.actions.mappings.getDocsLinkHref();
// the url from the mocked docs mock
expect(docsLinkHref).toEqual(
'https://www.elastic.co/guide/en/elasticsearch/reference/mocked-test-branch/mapping.html'
);
expect(docsLinkHref).toContain('mapping');
});
describe('Filter field by filter Type', () => {
const mockIndexMappingResponse: any = {
Expand Down Expand Up @@ -1023,9 +1021,7 @@ describe('<IndexDetailsPage />', () => {
await testBed.actions.clickIndexDetailsTab(IndexDetailsSection.Settings);
const docsLinkHref = testBed.actions.settings.getDocsLinkHref();
// the url from the mocked docs mock
expect(docsLinkHref).toEqual(
'https://www.elastic.co/guide/en/elasticsearch/reference/mocked-test-branch/index-modules.html#index-modules-settings'
);
expect(docsLinkHref).toContain('index-modules');
});

describe('error loading settings', () => {
Expand Down
2 changes: 1 addition & 1 deletion ...public/components/data_management/schema_editor/flyout/advanced_field_mapping_options.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ export const AdvancedFieldMappingOptions = ({
link: (
<EuiLink
data-test-subj="streamsAppAdvancedFieldMappingOptionsViewDocumentationLink"
href={core.docLinks.links.elasticsearch.docsBase.concat('mapping-params.html')}
href={core.docLinks.links.elasticsearch.mappingParameters}
target="_blank"
external
>
Expand Down
4 changes: 2 additions & 2 deletions x-pack/test/functional/apps/dataset_quality/degraded_field_flyout.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -808,7 +808,7 @@ export default function ({ getService, getPageObjects }: DatasetQualityFtrProvid

const linkURL = await linkButton.getAttribute('href');

expect(linkURL?.endsWith('mapping-settings-limit.html')).to.be(true);
expect(linkURL?.includes('mapping')).to.be(true);
});

it('should display increase field limit as a possible mitigation for special packages like apm app', async () => {
Expand Down Expand Up @@ -838,7 +838,7 @@ export default function ({ getService, getPageObjects }: DatasetQualityFtrProvid

const linkURL = await linkButton.getAttribute('href');

expect(linkURL?.endsWith('mapping-settings-limit.html')).to.be(true);
expect(linkURL?.includes('mapping')).to.be(true);
});

it('should display increase field limit as a possible mitigation for non integration', async () => {
Expand Down
2 changes: 1 addition & 1 deletion x-pack/test_serverless/functional/page_objects/svl_search_elasticsearch_start_page.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export function SvlSearchElasticsearchStartPageProvider({ getService }: FtrProvi
async expectAnalyzeLogsLink() {
await testSubjects.existOrFail('analyzeLogsBtn');
expect(await testSubjects.getAttribute('analyzeLogsBtn', 'href')).equal(
'https://www.elastic.co/guide/en/serverless/current/elasticsearch-ingest-your-data.html'
'https://www.elastic.co/docs/manage-data/ingest'
);
expect(await testSubjects.getAttribute('analyzeLogsBtn', 'target')).equal('_blank');
},
Expand Down
4 changes: 2 additions & 2 deletions ..._serverless/functional/test_suites/observability/dataset_quality/degraded_field_flyout.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -828,7 +828,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {

const linkURL = await linkButton.getAttribute('href');

expect(linkURL?.endsWith('mapping-settings-limit.html')).to.be(true);
expect(linkURL?.includes('mapping')).to.be(true);
});

it('should display increase field limit as a possible mitigation for special packages like apm app', async () => {
Expand Down Expand Up @@ -858,7 +858,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {

const linkURL = await linkButton.getAttribute('href');

expect(linkURL?.endsWith('mapping-settings-limit.html')).to.be(true);
expect(linkURL?.includes('mapping')).to.be(true);
});

it('should display increase field limit as a possible mitigation for non integration', async () => {
Expand Down