Skip to content

Comments

Use new security URLs in doc link service#219005

Merged
lcawl merged 12 commits intoelastic:mainfrom
lcawl:security-links
Apr 30, 2025
Merged

Use new security URLs in doc link service#219005
lcawl merged 12 commits intoelastic:mainfrom
lcawl:security-links

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Apr 23, 2025

Summary

Relates to #217722

This PR updates the Kibana doc link service with the appropriate URLs for the security, siem, and securityServerless URLs in the new docs system.

The following commands were run to pass the jest failures and update the snapshots:

yarn test:jest -u x-pack/platform/plugins/shared/security/public/management/roles/edit_role/privileges/es/elasticsearch_privileges.test.tsx
yarn test:jest -u x-pack/solutions/security/plugins/security_solution/public/management/pages/policy/view/policy_settings_form/components/related_detection_rules_callout.test.tsx
yarn test:jest -u src/platform/plugins/shared/ai_assistant_management/selection/public/routes/components/ai_assistant_selection_page.test.tsx
yarn test:jest -u x-pack/platform/plugins/shared/spaces/public/management/spaces_management_app.test.tsx   
yarn test:jest -u x-pack/solutions/security/plugins/security_solution/public/management/pages/policy/view/policy_settings_form/components/event_merging_banner.test.tsx
 

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 backport:version Backport to applied version labels v9.1.0 v9.0.1 labels Apr 23, 2025
@lcawl lcawl marked this pull request as ready for review April 23, 2025 17:59
@lcawl lcawl requested a review from a team as a code owner April 23, 2025 17:59
@elasticmachine
Copy link
Contributor

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

@lcawl lcawl requested a review from a team April 23, 2025 17:59
@lcawl lcawl requested review from a team as code owners April 23, 2025 20:10
@botelastic botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Apr 23, 2025
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@lcawl lcawl requested a review from a team as a code owner April 23, 2025 20:16
@lcawl lcawl requested review from parkiino and paul-tavares April 23, 2025 20:16
@lcawl lcawl requested a review from a team as a code owner April 25, 2025 15:46
@botelastic botelastic bot added the ci:project-deploy-observability Create an Observability project label Apr 25, 2025
@github-actions
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@elasticmachine
Copy link
Contributor

elasticmachine commented Apr 28, 2025

💛 Build succeeded, but was flaky

  • Buildkite Build
  • Commit: 8a0ca3c
  • Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-219005-8a0ca3c73d32

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #18 / Actions and Triggers app Connectors General connector functionality should reset connector when canceling an edit

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
aiAssistantManagementSelection 67.4KB 69.0KB +1.6KB
lists 114.1KB 115.7KB +1.6KB
total +3.3KB

Page load bundle

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

id before after diff
core 439.3KB 441.0KB +1.6KB

History

@lcawl lcawl merged commit cbf3742 into elastic:main Apr 30, 2025
9 checks passed
@lcawl lcawl deleted the security-links branch April 30, 2025 03:34
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 9.0

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

@kibanamachine
Copy link
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:
- [Core][UA] Forward-port 8.18 changes into main (#214996)

Manual backport

To create the backport manually run:

node scripts/backport --pr 219005

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Apr 30, 2025
@lcawl
Copy link
Contributor Author

lcawl commented Apr 30, 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

akowalska622 pushed a commit to akowalska622/kibana that referenced this pull request Apr 30, 2025
lcawl added a commit that referenced this pull request May 1, 2025
# Backport

This will backport the following commits from `main` to `9.0`:
- [Use new security URLs in doc link service
(#219005)](#219005)

<!--- 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-30T03:34:34Z","message":"Use
new security URLs in doc link service
(#219005)","sha":"cbf37421f9210169778148a1887e024c4d4ed1ea","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","Team:Fleet","ci:project-deploy-observability","backport:version","v9.1.0","v9.0.1"],"title":"Use
new security URLs in doc link
service","number":219005,"url":"https://github.com/elastic/kibana/pull/219005","mergeCommit":{"message":"Use
new security URLs in doc link service
(#219005)","sha":"cbf37421f9210169778148a1887e024c4d4ed1ea"}},"sourceBranch":"main","suggestedTargetBranches":["9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/219005","number":219005,"mergeCommit":{"message":"Use
new security URLs in doc link service
(#219005)","sha":"cbf37421f9210169778148a1887e024c4d4ed1ea"}},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
@mistic mistic added v9.0.2 and removed v9.0.1 labels May 6, 2025
akowalska622 pushed a commit to akowalska622/kibana that referenced this pull request May 29, 2025
natasha-moore-elastic added a commit that referenced this pull request Jun 17, 2025
…vice (#223388)

This PR replaces the old Security API doc links with API refence links
in the Kibana doc link service.

[This security-docs
PR](elastic/security-docs#6872), which removes
outdated Security Detections asciidoc API docs, is failing with the
following error:


> INFO:build_docs:Bad cross-document links:
> INFO:build_docs: Kibana [8.x]:
src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts contains
broken links to:
> INFO:build_docs:   - en/security/8.x/rule-api-overview.html
> INFO:build_docs:   - en/security/8.x/signals-migration-api.htm

Replacing these links in the Kibana doc link service should unblock the
docs PR.

The links were replaced in `main` in [this
PR](#219005).

---------

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Jacek Kolezynski <jacek.kolezynski@elastic.co>
natasha-moore-elastic added a commit to natasha-moore-elastic/kibana that referenced this pull request Jun 17, 2025
…vice (elastic#223388)

This PR replaces the old Security API doc links with API refence links
in the Kibana doc link service.

[This security-docs
PR](elastic/security-docs#6872), which removes
outdated Security Detections asciidoc API docs, is failing with the
following error:

> INFO:build_docs:Bad cross-document links:
> INFO:build_docs: Kibana [8.x]:
src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts contains
broken links to:
> INFO:build_docs:   - en/security/8.x/rule-api-overview.html
> INFO:build_docs:   - en/security/8.x/signals-migration-api.htm

Replacing these links in the Kibana doc link service should unblock the
docs PR.

The links were replaced in `main` in [this
PR](elastic#219005).

---------

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Jacek Kolezynski <jacek.kolezynski@elastic.co>
(cherry picked from commit 3579e5c)
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 ci:project-deploy-observability Create an Observability project release_note:skip Skip the PR/issue when compiling release notes Team:Docs Team:Fleet Team label for Observability Data Collection Fleet team v9.0.2 v9.1.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants