Skip to content

Commit

Permalink
[Create visualization modal] change documentation link in footer (#19…
Browse files Browse the repository at this point in the history
…6997)

## Summary

Fixes #196286 

Updated the documentation link in the footer of the create visualization
modal.

The `getDocLinks` guide link under "visualize" previously pointed to
dashboard.html, it's now corrected to _panels_and_visualizations.html.

This also affected a documentation link elsewhere, as seen in the
screenshot.

![visualize_library_documentation](https://github.com/user-attachments/assets/18d32942-063e-492e-85d8-274585eedb75)

Reverted it back using the "dashboard" guide link which also points to
dashboard.html since the issue specified changing only the create
visualization modal doc link.


https://github.com/user-attachments/assets/af6a4993-aac3-446f-8228-d0fe89d97cb2

---------

Co-authored-by: Marta Bondyra <[email protected]>
  • Loading branch information
VriaA and mbondyra authored Oct 22, 2024
1 parent 0ce828c commit 92b145b
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion packages/kbn-doc-links/src/get_doc_links.ts
Original file line number Diff line number Diff line change
Expand Up @@ -578,7 +578,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
alertingRules: `${ELASTICSEARCH_DOCS}transform-alerts.html`,
},
visualize: {
guide: `${KIBANA_DOCS}dashboard.html`,
guide: `${KIBANA_DOCS}_panels_and_visualizations.html`,
lens: `${ELASTIC_WEBSITE_URL}what-is/kibana-lens`,
lensPanels: `${KIBANA_DOCS}lens.html`,
maps: `${ELASTIC_WEBSITE_URL}maps`,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,11 @@ describe('GroupSelection', () => {

const docLinks = {
links: {
dashboard: {
visualize: {
guide: 'test',
},
},
};
} as unknown as DocLinksStart;

beforeAll(() => {
Object.defineProperty(window, 'location', {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ function GroupSelection({
visTypesRegistry,
...props
}: GroupSelectionProps) {
const visualizeGuideLink = props.docLinks.links.dashboard.guide;
const visualizeGuideLink = props.docLinks.links.visualize.guide;
const promotedVisGroups = useMemo(
() =>
orderBy(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,11 @@ describe('NewVisModal', () => {
const uiSettings: any = { get: settingsGet };
const docLinks = {
links: {
dashboard: {
visualize: {
guide: 'test',
},
},
};
} as unknown as DocLinksStart;

const contentManagement = contentManagementMock.createStartContract();

Expand All @@ -108,7 +108,7 @@ describe('NewVisModal', () => {
addBasePath={addBasePath}
uiSettings={uiSettings}
application={{} as ApplicationStart}
docLinks={docLinks as DocLinksStart}
docLinks={docLinks}
contentClient={contentManagement.client}
{...propsOverrides}
/>
Expand Down

0 comments on commit 92b145b

Please sign in to comment.