Skip to content

[DOCS] Use new responseOps URLs in doc link service and APIs#217601

Merged
lcawl merged 7 commits intoelastic:mainfrom
lcawl:doclink-service1
Apr 11, 2025
Merged

[DOCS] Use new responseOps URLs in doc link service and APIs#217601
lcawl merged 7 commits intoelastic:mainfrom
lcawl:doclink-service1

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Apr 9, 2025

Summary

Relates to #217722

This PR:

  • updates the doc link service to use the appropriate URLs for alerting, reporting, case, and task manager URLS in the new doc system
  • removes some keywords from the doc link service that no longer seem to be used anywhere
  • simplifies some URLs in the doc link service for which we previously had separate serverless and stack docs, since those pages have been consolidated in the new doc system
  • updates the URLs used in alerting, case, and task manager API docs

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 Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Feature:Task Manager Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// docs Feature:Cases Cases feature Feature:Reporting:CSV Reporting issues pertaining to CSV file export backport:version Backport to applied version labels v9.1.0 v9.0.1 labels Apr 9, 2025
@lcawl lcawl marked this pull request as ready for review April 9, 2025 01:50
@lcawl lcawl requested review from a team as code owners April 9, 2025 01:50
@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/response-ops-cases (Feature:Cases)

@lcawl lcawl requested a review from a team as a code owner April 9, 2025 15:26
@elasticmachine
Copy link
Copy Markdown
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #108 / saved objects tagging - functional tests feature controls tag management write privileges can bulk delete tags

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 82 81 -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 72.7KB 73.0KB +313.0B
lists 137.1KB 137.4KB +313.0B
total +626.0B

Page load bundle

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

id before after diff
core 432.5KB 432.8KB +313.0B
Unknown metric groups

API count

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

History

@wajihaparvez
Copy link
Copy Markdown
Contributor

LGTM!

Copy link
Copy Markdown
Contributor

@TinaHeiligers TinaHeiligers left a comment

Choose a reason for hiding this comment

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

LGTM

@lcawl lcawl merged commit 3908dc8 into elastic:main Apr 11, 2025
9 checks passed
@lcawl lcawl deleted the doclink-service1 branch April 11, 2025 00:18
@kibanamachine
Copy link
Copy Markdown
Contributor

Starting backport for target branches: 9.0

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

@kibanamachine
Copy link
Copy Markdown
Contributor

💔 All backports failed

Status Branch Result
9.0 Backport failed because of merge conflicts

You might need to backport the following PRs to 9.0:
- [DOCS] Add minimal synthetic APIs (#214518)

Manual backport

To create the backport manually run:

node scripts/backport --pr 217601

Questions ?

Please refer to the Backport tool documentation

@lcawl
Copy link
Copy Markdown
Contributor Author

lcawl commented Apr 11, 2025

💚 All backports created successfully

Status Branch Result
9.0

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

Questions ?

Please refer to the Backport tool documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:version Backport to applied version labels docs Feature:Alerting Feature:Cases Cases feature Feature:Reporting:CSV Reporting issues pertaining to CSV file export Feature:Task Manager release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// v9.0.1 v9.1.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants