Skip to content

Update API URLs in doc link service#215084

Merged
lcawl merged 20 commits intoelastic:mainfrom
lcawl:api-doc-links
Apr 16, 2025
Merged

Update API URLs in doc link service#215084
lcawl merged 20 commits intoelastic:mainfrom
lcawl:api-doc-links

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Mar 19, 2025 •
edited by kibanamachine
Loading

Summary

Relates to #217722

This PR:

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

@lcawl lcawl added Team:Docs release_note:skip Skip the PR/issue when compiling release notes docs backport:version Backport to applied version labels v9.1.0 v8.19.0 v8.18.1 v9.0.1 labels Mar 19, 2025
@lcawl lcawl marked this pull request as ready for review March 19, 2025 05:11
@lcawl lcawl requested review from a team as code owners March 19, 2025 05:11
@elasticmachine
Copy link
Contributor

elasticmachine commented Mar 19, 2025

Pinging @elastic/kibana-docs (Team:Docs)

@lcawl lcawl requested a review from a team as a code owner March 19, 2025 14:56
@lcawl lcawl marked this pull request as draft March 19, 2025 21:10
@lcawl lcawl marked this pull request as ready for review March 19, 2025 21:33
sabarasaba
sabarasaba reviewed Mar 20, 2025
View reviewed changes
Copy link
Member

@sabarasaba sabarasaba left a comment

Choose a reason for hiding this comment

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

I left one small comment, let me know!

@jloleysens
Copy link
Contributor

jloleysens commented Mar 20, 2025 •
edited
Loading

IMO it seems to defeat the purpose of having the doc link service if we then hard-code the URLs in the tests.

Yeah, I agree this is not well suited to large scale changes. Kibana uses snapshots in UI tests quite heavily and they do provide some level of assurance that we'll be getting the right URL in the UI and I don't see that practice going away soon... at least having the path reflected in tests might not be the worst idea? Otherwise we should fully stub out the URLs (there are ways to do this too...).

I totally see how this kind of refactor is made painful though! OTOH we don't expect these URLs to change in this large scale fashion often so I'd like to make sure any change we do/do not make has that trade off in mind.

Let me take this to the Core team!

lcawl and others added 2 commits March 20, 2025 14:31
@lcawl @sabarasaba
Update x-pack/platform/plugins/shared/index_management/__jest__/clien…
94d4437 
…t_integration/index_details_page/index_details_page.test.tsx

Co-authored-by: Ignacio Rivas <rivasign@gmail.com>
@lcawl
Merge branch 'main' into api-doc-links
626bead
@lcawl lcawl mentioned this pull request Mar 20, 2025
Closed
9 tasks
@jloleysens jloleysens removed their request for review April 11, 2025 08:50
@elasticmachine
Copy link
Contributor

elasticmachine commented Apr 16, 2025

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
@kbn/doc-links 81 82 +1

Async chunks

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

id before after diff
aiAssistantManagementSelection 73.0KB 75.0KB +2.0KB
lists 137.4KB 139.4KB +2.0KB
total +3.9KB

Page load bundle

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

id before after diff
core 433.5KB 435.5KB +2.0KB
Unknown metric groups

API count

id before after diff
@kbn/doc-links 81 82 +1

History

@lcawl lcawl requested a review from sabarasaba April 16, 2025 00:05
SoniaSanzV
SoniaSanzV approved these changes Apr 16, 2025
View reviewed changes
Copy link
Contributor

@SoniaSanzV SoniaSanzV left a comment

Choose a reason for hiding this comment

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

Kibana management changes lgtm :)

@lcawl lcawl merged commit b969cc9 into elastic:main Apr 16, 2025
9 checks passed
@kibanamachine
Copy link
Contributor

kibanamachine commented Apr 16, 2025

Starting backport for target branches: 8.18, 8.x, 9.0

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

@lcawl lcawl deleted the api-doc-links branch April 16, 2025 14:19
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Apr 16, 2025
@lcawl @sabarasaba @jloleysens
Update API URLs in doc link service (elastic#215084)
ce09ce5 
Co-authored-by: Ignacio Rivas <rivasign@gmail.com>
Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
(cherry picked from commit b969cc9)
@kibanamachine kibanamachine mentioned this pull request Apr 16, 2025
Merged
@kibanamachine
Copy link
Contributor

kibanamachine commented Apr 16, 2025

💔 Some backports could not be created

Status Branch Result
❌ 8.18 Backport failed because of merge conflicts
❌ 8.x Backport failed because of merge conflicts
✅ 9.0

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

Manual backport

To create the backport manually run:

node scripts/backport --pr 215084

Questions ?

Please refer to the Backport tool documentation

@kibanamachine kibanamachine mentioned this pull request Apr 16, 2025
Merged
@lcawl lcawl mentioned this pull request Apr 16, 2025
Merged
lcawl added a commit to lcawl/kibana that referenced this pull request Apr 16, 2025
@lcawl @sabarasaba @jloleysens
Update API URLs in doc link service (elastic#215084)
bcebdfa 
Co-authored-by: Ignacio Rivas <rivasign@gmail.com>
Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
(cherry picked from commit b969cc9)
lcawl added a commit to lcawl/kibana that referenced this pull request Apr 16, 2025
@lcawl @sabarasaba @jloleysens
Update API URLs in doc link service (elastic#215084)
c0768ea 
Co-authored-by: Ignacio Rivas <rivasign@gmail.com>
Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
(cherry picked from commit b969cc9)
@lcawl lcawl mentioned this pull request Apr 16, 2025
Merged
@lcawl
Copy link
Contributor Author

lcawl commented Apr 16, 2025

💚 All backports created successfully

Status Branch Result
✅ 8.x
✅ 8.18

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

Questions ?

Please refer to the Backport tool documentation

akowalska622 pushed a commit to akowalska622/kibana that referenced this pull request Apr 17, 2025
@lcawl @sabarasaba
@jloleysens @akowalska622
Update API URLs in doc link service (elastic#215084)
555e3eb 
Co-authored-by: Ignacio Rivas <rivasign@gmail.com>
Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Apr 18, 2025
@kibanamachine
Copy link
Contributor

kibanamachine commented Apr 18, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

1 similar comment
@kibanamachine
Copy link
Contributor

kibanamachine commented Apr 21, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@lcawl lcawl mentioned this pull request Apr 21, 2025
Merged
@kibanamachine kibanamachine mentioned this pull request Apr 21, 2025
Merged
@kibanamachine
Copy link
Contributor

kibanamachine commented Apr 22, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

lcawl added a commit that referenced this pull request Apr 22, 2025
@kibanamachine @lcawl
[9.0] Update API URLs in doc link service (#215084) (#218457)
14dfb5d 
# Backport

This will backport the following commits from `main` to `9.0`:
- [Update API URLs in doc link service
(#215084)](#215084)

<!--- Backport version: 9.6.6 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-04-16T14:18:47Z","message":"Update
API URLs in doc link service (#215084)\n\n\nCo-authored-by: Ignacio
Rivas <rivasign@gmail.com>\nCo-authored-by: Jean-Louis Leysens
<jloleysens@gmail.com>","sha":"b969cc9e3dac819c0498ab2e68e27a74c4b91a88","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"Update
API URLs in doc link
service","number":215084,"url":"https://github.com/elastic/kibana/pull/215084","mergeCommit":{"message":"Update
API URLs in doc link service (#215084)\n\n\nCo-authored-by: Ignacio
Rivas <rivasign@gmail.com>\nCo-authored-by: Jean-Louis Leysens
<jloleysens@gmail.com>","sha":"b969cc9e3dac819c0498ab2e68e27a74c4b91a88"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/215084","number":215084,"mergeCommit":{"message":"Update
API URLs in doc link service (#215084)\n\n\nCo-authored-by: Ignacio
Rivas <rivasign@gmail.com>\nCo-authored-by: Jean-Louis Leysens
<jloleysens@gmail.com>","sha":"b969cc9e3dac819c0498ab2e68e27a74c4b91a88"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
lcawl added a commit that referenced this pull request Apr 22, 2025
@lcawl
[8.18] Update API URLs in doc link service (#215084) (#218493)
f90e078 
# Backport

This will backport the following commits from `main` to `8.18`:
- [Update API URLs in doc link service
(#215084)](#215084)

<!--- Backport version: 9.6.6 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-04-16T14:18:47Z","message":"Update
API URLs in doc link service (#215084)\n\n\nCo-authored-by: Ignacio
Rivas <rivasign@gmail.com>\nCo-authored-by: Jean-Louis Leysens
<jloleysens@gmail.com>","sha":"b969cc9e3dac819c0498ab2e68e27a74c4b91a88","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"Update
API URLs in doc link
service","number":215084,"url":"https://github.com/elastic/kibana/pull/215084","mergeCommit":{"message":"Update
API URLs in doc link service (#215084)\n\n\nCo-authored-by: Ignacio
Rivas <rivasign@gmail.com>\nCo-authored-by: Jean-Louis Leysens
<jloleysens@gmail.com>","sha":"b969cc9e3dac819c0498ab2e68e27a74c4b91a88"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/215084","number":215084,"mergeCommit":{"message":"Update
API URLs in doc link service (#215084)\n\n\nCo-authored-by: Ignacio
Rivas <rivasign@gmail.com>\nCo-authored-by: Jean-Louis Leysens
<jloleysens@gmail.com>","sha":"b969cc9e3dac819c0498ab2e68e27a74c4b91a88"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/218457","number":218457,"state":"OPEN"}]}]
BACKPORT-->
lcawl added a commit that referenced this pull request Apr 22, 2025
@lcawl
[8.x] Update API URLs in doc link service (#215084) (#218492)
f77d11c 
# Backport

This will backport the following commits from `main` to `8.x`:
- [Update API URLs in doc link service
(#215084)](#215084)

<!--- Backport version: 9.6.6 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-04-16T14:18:47Z","message":"Update
API URLs in doc link service (#215084)\n\n\nCo-authored-by: Ignacio
Rivas <rivasign@gmail.com>\nCo-authored-by: Jean-Louis Leysens
<jloleysens@gmail.com>","sha":"b969cc9e3dac819c0498ab2e68e27a74c4b91a88","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"Update
API URLs in doc link
service","number":215084,"url":"https://github.com/elastic/kibana/pull/215084","mergeCommit":{"message":"Update
API URLs in doc link service (#215084)\n\n\nCo-authored-by: Ignacio
Rivas <rivasign@gmail.com>\nCo-authored-by: Jean-Louis Leysens
<jloleysens@gmail.com>","sha":"b969cc9e3dac819c0498ab2e68e27a74c4b91a88"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/215084","number":215084,"mergeCommit":{"message":"Update
API URLs in doc link service (#215084)\n\n\nCo-authored-by: Ignacio
Rivas <rivasign@gmail.com>\nCo-authored-by: Jean-Louis Leysens
<jloleysens@gmail.com>","sha":"b969cc9e3dac819c0498ab2e68e27a74c4b91a88"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/218457","number":218457,"state":"OPEN"}]}]
BACKPORT-->
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Apr 22, 2025
akowalska622 pushed a commit to akowalska622/kibana that referenced this pull request May 29, 2025
@lcawl @sabarasaba
@jloleysens @akowalska622
Update API URLs in doc link service (elastic#215084)
bcf662b 
Co-authored-by: Ignacio Rivas <rivasign@gmail.com>
Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TinaHeiligers TinaHeiligers TinaHeiligers approved these changes

@wajihaparvez wajihaparvez wajihaparvez approved these changes

@SoniaSanzV SoniaSanzV SoniaSanzV approved these changes

@sabarasaba sabarasaba Awaiting requested review from sabarasaba

Assignees

No one assigned

Labels

backport:version Backport to applied version labels docs release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.18.1 v8.19.0 v9.0.1 v9.1.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@lcawl @elasticmachine @jloleysens @wajihaparvez @kibanamachine @sabarasaba @TinaHeiligers @SoniaSanzV