Skip to content
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

Jump to bottom

Fix broken documentation links in the App Search plugin #198572

Merged
merged 3 commits into from
Oct 31, 2024
Merged

Fix broken documentation links in the App Search plugin #198572

merged 3 commits into from
Oct 31, 2024

Conversation

afoucret
Copy link
Contributor

@afoucret afoucret commented Oct 31, 2024 •
edited by kibanamachine
Loading

The bug was caused by the method used to pass URL to the EuiButton or the EuiLink components.

Indeed the links were imported by using (example for synonym but there are dozen of similar example):

import { SYNONYMS_DOCS_URL } from '../../../routes';

where SYNONYMS_DOCS_URL was defined with:

export const SYNONYMS_DOCS_URL = docLinks.appSearchSynonyms;

My assumption is that docLinks were not instantiated completely when imported.

@afoucret afoucret added bug Fixes for quality problems that affect the customer experience v9.0.0 auto-backport Deprecated - use backport:version if exact versions are needed Team:EnterpriseSearch v8.16.0 v8.17.0 labels Oct 31, 2024
@afoucret afoucret requested a review from a team as a code owner October 31, 2024 15:56
@afoucret afoucret added release_note:skip Skip the PR/issue when compiling release notes backport:prev-major Backport to (8.x, 8.17, 8.16) the previous major branch and other branches in development labels Oct 31, 2024
afoucret
afoucret commented Oct 31, 2024
View reviewed changes
...erprise_search/public/applications/app_search/components/api_logs/components/empty_state.tsx
@@ -11,7 +11,7 @@ import { EuiButton, EuiEmptyPrompt } from '@elastic/eui';

import { i18n } from '@kbn/i18n';

import { API_DOCS_URL } from '../../../routes';
import { docLinks } from '../../../../shared/doc_links';
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am not very happy with this import and would prefer to use a property for the component. But considering the number of components to be updated, it would be too long and risky to do it like this.

it will be good enough to fix the issue before 8.16.0 is released and we can revisit it later.

sphilipse
sphilipse approved these changes Oct 31, 2024
View reviewed changes
Copy link
Member

@sphilipse sphilipse left a comment

Choose a reason for hiding this comment

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

This is a fine fix AFAIC

kderusso
kderusso approved these changes Oct 31, 2024
View reviewed changes
Copy link
Member

@kderusso kderusso left a comment

Choose a reason for hiding this comment

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

LGTM

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
enterpriseSearch 2.6MB 2.6MB +634.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
enterpriseSearch 54.5KB 53.3KB -1.3KB

History

@afoucret afoucret merged commit 80d5121 into elastic:main Oct 31, 2024
21 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.15, 8.16, 8.x

https://github.com/elastic/kibana/actions/runs/11618091647

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Oct 31, 2024
@afoucret
Fix broken documentation links in the App Search plugin (elastic#198572)
e3e8df7 
(cherry picked from commit 80d5121)
@kibanamachine kibanamachine mentioned this pull request Oct 31, 2024
Merged
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Oct 31, 2024
@afoucret
Fix broken documentation links in the App Search plugin (elastic#198572)
c913bab 
(cherry picked from commit 80d5121)
@kibanamachine kibanamachine mentioned this pull request Oct 31, 2024
Merged
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Oct 31, 2024
@afoucret
Fix broken documentation links in the App Search plugin (elastic#198572)
4a7cce6 
(cherry picked from commit 80d5121)
@kibanamachine kibanamachine mentioned this pull request Oct 31, 2024
Merged
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
✅ 8.15
✅ 8.16
✅ 8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Oct 31, 2024
@kibanamachine @afoucret
[8.15] Fix broken documentation links in the App Search plugin (#198572…
de26287 
…) (#198603)

# Backport

This will backport the following commits from `main` to `8.15`:
- [Fix broken documentation links in the App Search plugin
(#198572)](#198572)

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

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

<!--BACKPORT [{"author":{"name":"Aurélien
FOUCRET","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-31T18:53:14Z","message":"Fix
broken documentation links in the App Search plugin
(#198572)","sha":"80d5121b80f3bbd452b5b02fc05c944802ac8c46","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:skip","v9.0.0","auto-backport","Team:EnterpriseSearch","backport:prev-major","v8.15.0","v8.16.0","v8.17.0"],"title":"Fix
broken documentation links in the App Search
plugin","number":198572,"url":"https://github.com/elastic/kibana/pull/198572","mergeCommit":{"message":"Fix
broken documentation links in the App Search plugin
(#198572)","sha":"80d5121b80f3bbd452b5b02fc05c944802ac8c46"}},"sourceBranch":"main","suggestedTargetBranches":["8.15","8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/198572","number":198572,"mergeCommit":{"message":"Fix
broken documentation links in the App Search plugin
(#198572)","sha":"80d5121b80f3bbd452b5b02fc05c944802ac8c46"}},{"branch":"8.15","label":"v8.15.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Aurélien FOUCRET <[email protected]>
kibanamachine added a commit that referenced this pull request Oct 31, 2024
@kibanamachine @afoucret
[8.16] Fix broken documentation links in the App Search plugin (#198572…
0e3ac47 
…) (#198604)

# Backport

This will backport the following commits from `main` to `8.16`:
- [Fix broken documentation links in the App Search plugin
(#198572)](#198572)

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

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

<!--BACKPORT [{"author":{"name":"Aurélien
FOUCRET","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-31T18:53:14Z","message":"Fix
broken documentation links in the App Search plugin
(#198572)","sha":"80d5121b80f3bbd452b5b02fc05c944802ac8c46","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:skip","v9.0.0","auto-backport","Team:EnterpriseSearch","backport:prev-major","v8.15.0","v8.16.0","v8.17.0"],"title":"Fix
broken documentation links in the App Search
plugin","number":198572,"url":"https://github.com/elastic/kibana/pull/198572","mergeCommit":{"message":"Fix
broken documentation links in the App Search plugin
(#198572)","sha":"80d5121b80f3bbd452b5b02fc05c944802ac8c46"}},"sourceBranch":"main","suggestedTargetBranches":["8.15","8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/198572","number":198572,"mergeCommit":{"message":"Fix
broken documentation links in the App Search plugin
(#198572)","sha":"80d5121b80f3bbd452b5b02fc05c944802ac8c46"}},{"branch":"8.15","label":"v8.15.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Aurélien FOUCRET <[email protected]>
kibanamachine added a commit that referenced this pull request Oct 31, 2024
@kibanamachine @afoucret
[8.x] Fix broken documentation links in the App Search plugin (#198572)…
bcc2127 
… (#198605)

# Backport

This will backport the following commits from `main` to `8.x`:
- [Fix broken documentation links in the App Search plugin
(#198572)](#198572)

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

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

<!--BACKPORT [{"author":{"name":"Aurélien
FOUCRET","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-31T18:53:14Z","message":"Fix
broken documentation links in the App Search plugin
(#198572)","sha":"80d5121b80f3bbd452b5b02fc05c944802ac8c46","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:skip","v9.0.0","auto-backport","Team:EnterpriseSearch","backport:prev-major","v8.15.0","v8.16.0","v8.17.0"],"title":"Fix
broken documentation links in the App Search
plugin","number":198572,"url":"https://github.com/elastic/kibana/pull/198572","mergeCommit":{"message":"Fix
broken documentation links in the App Search plugin
(#198572)","sha":"80d5121b80f3bbd452b5b02fc05c944802ac8c46"}},"sourceBranch":"main","suggestedTargetBranches":["8.15","8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/198572","number":198572,"mergeCommit":{"message":"Fix
broken documentation links in the App Search plugin
(#198572)","sha":"80d5121b80f3bbd452b5b02fc05c944802ac8c46"}},{"branch":"8.15","label":"v8.15.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Aurélien FOUCRET <[email protected]>
nreese pushed a commit to nreese/kibana that referenced this pull request Nov 1, 2024
@afoucret @nreese
Fix broken documentation links in the App Search plugin (elastic#198572)
05153b4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sphilipse sphilipse sphilipse approved these changes

@kderusso kderusso kderusso approved these changes

Assignees
No one assigned
Labels
auto-backport Deprecated - use backport:version if exact versions are needed backport:prev-major Backport to (8.x, 8.17, 8.16) the previous major branch and other branches in development bug Fixes for quality problems that affect the customer experience release_note:skip Skip the PR/issue when compiling release notes Team:EnterpriseSearch v8.15.0 v8.15.4 v8.16.0 v8.17.0 v9.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@afoucret @elasticmachine @kibanamachine @kderusso @sphilipse