Skip to content

Commit

Permalink
[8.x] [Create visualization modal] change documentation link in footer (
Browse files Browse the repository at this point in the history
#196997) (#197207)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Create visualization modal] change documentation link in footer
(#196997)](#196997)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Oyelola
Victoria","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-22T10:44:14Z","message":"[Create
visualization modal] change documentation link in footer (#196997)\n\n##
Summary\r\n\r\nFixes #196286 \r\n\r\nUpdated the documentation link in
the footer of the create visualization\r\nmodal.\r\n\r\nThe
`getDocLinks` guide link under \"visualize\" previously pointed
to\r\ndashboard.html, it's now corrected to
_panels_and_visualizations.html.\r\n\r\nThis also affected a
documentation link elsewhere, as seen in
the\r\nscreenshot.\r\n\r\n![visualize_library_documentation](https://github.com/user-attachments/assets/18d32942-063e-492e-85d8-274585eedb75)\r\n\r\nReverted
it back using the \"dashboard\" guide link which also points
to\r\ndashboard.html since the issue specified changing only the
create\r\nvisualization modal doc
link.\r\n\r\n\r\nhttps://github.com/user-attachments/assets/af6a4993-aac3-446f-8228-d0fe89d97cb2\r\n\r\n---------\r\n\r\nCo-authored-by:
Marta Bondyra
<[email protected]>","sha":"92b145bcd739af9e132be158c08ba2f3c8cd43d1","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Visualizations","release_note:skip","💝community","v9.0.0","backport:prev-minor"],"title":"[Create
visualization modal] change documentation link in
footer","number":196997,"url":"https://github.com/elastic/kibana/pull/196997","mergeCommit":{"message":"[Create
visualization modal] change documentation link in footer (#196997)\n\n##
Summary\r\n\r\nFixes #196286 \r\n\r\nUpdated the documentation link in
the footer of the create visualization\r\nmodal.\r\n\r\nThe
`getDocLinks` guide link under \"visualize\" previously pointed
to\r\ndashboard.html, it's now corrected to
_panels_and_visualizations.html.\r\n\r\nThis also affected a
documentation link elsewhere, as seen in
the\r\nscreenshot.\r\n\r\n![visualize_library_documentation](https://github.com/user-attachments/assets/18d32942-063e-492e-85d8-274585eedb75)\r\n\r\nReverted
it back using the \"dashboard\" guide link which also points
to\r\ndashboard.html since the issue specified changing only the
create\r\nvisualization modal doc
link.\r\n\r\n\r\nhttps://github.com/user-attachments/assets/af6a4993-aac3-446f-8228-d0fe89d97cb2\r\n\r\n---------\r\n\r\nCo-authored-by:
Marta Bondyra
<[email protected]>","sha":"92b145bcd739af9e132be158c08ba2f3c8cd43d1"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/196997","number":196997,"mergeCommit":{"message":"[Create
visualization modal] change documentation link in footer (#196997)\n\n##
Summary\r\n\r\nFixes #196286 \r\n\r\nUpdated the documentation link in
the footer of the create visualization\r\nmodal.\r\n\r\nThe
`getDocLinks` guide link under \"visualize\" previously pointed
to\r\ndashboard.html, it's now corrected to
_panels_and_visualizations.html.\r\n\r\nThis also affected a
documentation link elsewhere, as seen in
the\r\nscreenshot.\r\n\r\n![visualize_library_documentation](https://github.com/user-attachments/assets/18d32942-063e-492e-85d8-274585eedb75)\r\n\r\nReverted
it back using the \"dashboard\" guide link which also points
to\r\ndashboard.html since the issue specified changing only the
create\r\nvisualization modal doc
link.\r\n\r\n\r\nhttps://github.com/user-attachments/assets/af6a4993-aac3-446f-8228-d0fe89d97cb2\r\n\r\n---------\r\n\r\nCo-authored-by:
Marta Bondyra
<[email protected]>","sha":"92b145bcd739af9e132be158c08ba2f3c8cd43d1"}}]}]
BACKPORT-->

Co-authored-by: Oyelola Victoria <[email protected]>
  • Loading branch information
kibanamachine and VriaA authored Oct 22, 2024
1 parent 8fc3669 commit 3e6889d
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 @@ -581,7 +581,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 3e6889d

Please sign in to comment.