Skip to content

[skip CI] [scout] update docs with recent changes and examples#232985

Merged
dmlemeshko merged 6 commits intoelastic:mainfrom
dmlemeshko:scout/update-docs
Aug 27, 2025
Merged

[skip CI] [scout] update docs with recent changes and examples#232985
dmlemeshko merged 6 commits intoelastic:mainfrom
dmlemeshko:scout/update-docs

Conversation

@dmlemeshko
Copy link
Contributor

@dmlemeshko dmlemeshko commented Aug 26, 2025

Summary

This pull request updates the kbn-scout package's documentation to reflect a major reorganization of its directory structure, and provides extended guidelines for writing UI and API tests using Scout.

The README now details new directories, improved explanations of test types (UI, API), and best practices for plugin developers.

@dmlemeshko dmlemeshko changed the title [scout] update docs with recent changes and examples [skip CI] [scout] update docs with recent changes and examples Aug 26, 2025
@dmlemeshko dmlemeshko requested a review from csr August 26, 2025 14:33
@dmlemeshko dmlemeshko added backport:all-open Backport to all branches that could still receive a release release_note:skip Skip the PR/issue when compiling release notes test:scout labels Aug 26, 2025
@dmlemeshko dmlemeshko marked this pull request as ready for review August 26, 2025 15:42
@dmlemeshko dmlemeshko requested a review from a team as a code owner August 26, 2025 15:43
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

dmlemeshko and others added 4 commits August 27, 2025 10:00
Co-authored-by: Cesare de Cal <cesare.decal@elastic.co>
Co-authored-by: Cesare de Cal <cesare.decal@elastic.co>
Co-authored-by: Cesare de Cal <cesare.decal@elastic.co>
@dmlemeshko dmlemeshko requested a review from csr August 27, 2025 08:06
Copy link
Contributor

@csr csr left a comment

Choose a reason for hiding this comment

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

LGTM

@dmlemeshko dmlemeshko merged commit 328eea6 into elastic:main Aug 27, 2025
13 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.18, 8.19, 9.0, 9.1

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

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Aug 27, 2025
…ic#232985)

## Summary

This pull request updates the `kbn-scout` package's documentation to
reflect a major reorganization of its directory structure, and provides
extended guidelines for writing UI and API tests using Scout.

The README now details new directories, improved explanations of test
types (UI, API), and best practices for plugin developers.

---------

Co-authored-by: Cesare de Cal <cesare.decal@elastic.co>
(cherry picked from commit 328eea6)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Aug 27, 2025
…ic#232985)

## Summary

This pull request updates the `kbn-scout` package's documentation to
reflect a major reorganization of its directory structure, and provides
extended guidelines for writing UI and API tests using Scout.

The README now details new directories, improved explanations of test
types (UI, API), and best practices for plugin developers.

---------

Co-authored-by: Cesare de Cal <cesare.decal@elastic.co>
(cherry picked from commit 328eea6)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Aug 27, 2025
…ic#232985)

## Summary

This pull request updates the `kbn-scout` package's documentation to
reflect a major reorganization of its directory structure, and provides
extended guidelines for writing UI and API tests using Scout.

The README now details new directories, improved explanations of test
types (UI, API), and best practices for plugin developers.

---------

Co-authored-by: Cesare de Cal <cesare.decal@elastic.co>
(cherry picked from commit 328eea6)
@kibanamachine
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
8.18 Backport failed because of merge conflicts

You might need to backport the following PRs to 8.18:
- SKA: Relocate "platform" packages that remain on /packages (#208704)
8.19
9.0
9.1

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

Manual backport

To create the backport manually run:

node scripts/backport --pr 232985

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Aug 27, 2025
…232985) (#233106)

# Backport

This will backport the following commits from `main` to `9.0`:
- [[skip CI] [scout] update docs with recent changes and examples
(#232985)](#232985)

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

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

<!--BACKPORT [{"author":{"name":"Dzmitry
Lemechko","email":"dzmitry.lemechko@elastic.co"},"sourceCommit":{"committedDate":"2025-08-27T12:27:32Z","message":"[skip
CI] [scout] update docs with recent changes and examples (#232985)\n\n##
Summary\n\nThis pull request updates the `kbn-scout` package's
documentation to\nreflect a major reorganization of its directory
structure, and provides\nextended guidelines for writing UI and API
tests using Scout.\n\nThe README now details new directories, improved
explanations of test\ntypes (UI, API), and best practices for plugin
developers.\n\n---------\n\nCo-authored-by: Cesare de Cal
<cesare.decal@elastic.co>","sha":"328eea6f99dfad774ecb7db9fd550beca20a2668","branchLabelMapping":{"^v9.2.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:all-open","test:scout","v9.2.0"],"title":"[skip
CI] [scout] update docs with recent changes and
examples","number":232985,"url":"https://github.com/elastic/kibana/pull/232985","mergeCommit":{"message":"[skip
CI] [scout] update docs with recent changes and examples (#232985)\n\n##
Summary\n\nThis pull request updates the `kbn-scout` package's
documentation to\nreflect a major reorganization of its directory
structure, and provides\nextended guidelines for writing UI and API
tests using Scout.\n\nThe README now details new directories, improved
explanations of test\ntypes (UI, API), and best practices for plugin
developers.\n\n---------\n\nCo-authored-by: Cesare de Cal
<cesare.decal@elastic.co>","sha":"328eea6f99dfad774ecb7db9fd550beca20a2668"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.2.0","branchLabelMappingKey":"^v9.2.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/232985","number":232985,"mergeCommit":{"message":"[skip
CI] [scout] update docs with recent changes and examples (#232985)\n\n##
Summary\n\nThis pull request updates the `kbn-scout` package's
documentation to\nreflect a major reorganization of its directory
structure, and provides\nextended guidelines for writing UI and API
tests using Scout.\n\nThe README now details new directories, improved
explanations of test\ntypes (UI, API), and best practices for plugin
developers.\n\n---------\n\nCo-authored-by: Cesare de Cal
<cesare.decal@elastic.co>","sha":"328eea6f99dfad774ecb7db9fd550beca20a2668"}}]}]
BACKPORT-->

Co-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co>
Co-authored-by: Cesare de Cal <cesare.decal@elastic.co>
kibanamachine added a commit that referenced this pull request Aug 27, 2025
…232985) (#233107)

# Backport

This will backport the following commits from `main` to `9.1`:
- [[skip CI] [scout] update docs with recent changes and examples
(#232985)](#232985)

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

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

<!--BACKPORT [{"author":{"name":"Dzmitry
Lemechko","email":"dzmitry.lemechko@elastic.co"},"sourceCommit":{"committedDate":"2025-08-27T12:27:32Z","message":"[skip
CI] [scout] update docs with recent changes and examples (#232985)\n\n##
Summary\n\nThis pull request updates the `kbn-scout` package's
documentation to\nreflect a major reorganization of its directory
structure, and provides\nextended guidelines for writing UI and API
tests using Scout.\n\nThe README now details new directories, improved
explanations of test\ntypes (UI, API), and best practices for plugin
developers.\n\n---------\n\nCo-authored-by: Cesare de Cal
<cesare.decal@elastic.co>","sha":"328eea6f99dfad774ecb7db9fd550beca20a2668","branchLabelMapping":{"^v9.2.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:all-open","test:scout","v9.2.0"],"title":"[skip
CI] [scout] update docs with recent changes and
examples","number":232985,"url":"https://github.com/elastic/kibana/pull/232985","mergeCommit":{"message":"[skip
CI] [scout] update docs with recent changes and examples (#232985)\n\n##
Summary\n\nThis pull request updates the `kbn-scout` package's
documentation to\nreflect a major reorganization of its directory
structure, and provides\nextended guidelines for writing UI and API
tests using Scout.\n\nThe README now details new directories, improved
explanations of test\ntypes (UI, API), and best practices for plugin
developers.\n\n---------\n\nCo-authored-by: Cesare de Cal
<cesare.decal@elastic.co>","sha":"328eea6f99dfad774ecb7db9fd550beca20a2668"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.2.0","branchLabelMappingKey":"^v9.2.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/232985","number":232985,"mergeCommit":{"message":"[skip
CI] [scout] update docs with recent changes and examples (#232985)\n\n##
Summary\n\nThis pull request updates the `kbn-scout` package's
documentation to\nreflect a major reorganization of its directory
structure, and provides\nextended guidelines for writing UI and API
tests using Scout.\n\nThe README now details new directories, improved
explanations of test\ntypes (UI, API), and best practices for plugin
developers.\n\n---------\n\nCo-authored-by: Cesare de Cal
<cesare.decal@elastic.co>","sha":"328eea6f99dfad774ecb7db9fd550beca20a2668"}}]}]
BACKPORT-->

Co-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co>
Co-authored-by: Cesare de Cal <cesare.decal@elastic.co>
kibanamachine added a commit that referenced this pull request Aug 27, 2025
…#232985) (#233105)

# Backport

This will backport the following commits from `main` to `8.19`:
- [[skip CI] [scout] update docs with recent changes and examples
(#232985)](#232985)

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

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

<!--BACKPORT [{"author":{"name":"Dzmitry
Lemechko","email":"dzmitry.lemechko@elastic.co"},"sourceCommit":{"committedDate":"2025-08-27T12:27:32Z","message":"[skip
CI] [scout] update docs with recent changes and examples (#232985)\n\n##
Summary\n\nThis pull request updates the `kbn-scout` package's
documentation to\nreflect a major reorganization of its directory
structure, and provides\nextended guidelines for writing UI and API
tests using Scout.\n\nThe README now details new directories, improved
explanations of test\ntypes (UI, API), and best practices for plugin
developers.\n\n---------\n\nCo-authored-by: Cesare de Cal
<cesare.decal@elastic.co>","sha":"328eea6f99dfad774ecb7db9fd550beca20a2668","branchLabelMapping":{"^v9.2.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:all-open","test:scout","v9.2.0"],"title":"[skip
CI] [scout] update docs with recent changes and
examples","number":232985,"url":"https://github.com/elastic/kibana/pull/232985","mergeCommit":{"message":"[skip
CI] [scout] update docs with recent changes and examples (#232985)\n\n##
Summary\n\nThis pull request updates the `kbn-scout` package's
documentation to\nreflect a major reorganization of its directory
structure, and provides\nextended guidelines for writing UI and API
tests using Scout.\n\nThe README now details new directories, improved
explanations of test\ntypes (UI, API), and best practices for plugin
developers.\n\n---------\n\nCo-authored-by: Cesare de Cal
<cesare.decal@elastic.co>","sha":"328eea6f99dfad774ecb7db9fd550beca20a2668"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.2.0","branchLabelMappingKey":"^v9.2.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/232985","number":232985,"mergeCommit":{"message":"[skip
CI] [scout] update docs with recent changes and examples (#232985)\n\n##
Summary\n\nThis pull request updates the `kbn-scout` package's
documentation to\nreflect a major reorganization of its directory
structure, and provides\nextended guidelines for writing UI and API
tests using Scout.\n\nThe README now details new directories, improved
explanations of test\ntypes (UI, API), and best practices for plugin
developers.\n\n---------\n\nCo-authored-by: Cesare de Cal
<cesare.decal@elastic.co>","sha":"328eea6f99dfad774ecb7db9fd550beca20a2668"}}]}]
BACKPORT-->

Co-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co>
Co-authored-by: Cesare de Cal <cesare.decal@elastic.co>
kowalczyk-krzysztof pushed a commit to kowalczyk-krzysztof/kibana that referenced this pull request Aug 30, 2025
…ic#232985)

## Summary

This pull request updates the `kbn-scout` package's documentation to
reflect a major reorganization of its directory structure, and provides
extended guidelines for writing UI and API tests using Scout.

The README now details new directories, improved explanations of test
types (UI, API), and best practices for plugin developers.

---------

Co-authored-by: Cesare de Cal <cesare.decal@elastic.co>
qn895 pushed a commit to qn895/kibana that referenced this pull request Sep 2, 2025
…ic#232985)

## Summary

This pull request updates the `kbn-scout` package's documentation to
reflect a major reorganization of its directory structure, and provides
extended guidelines for writing UI and API tests using Scout.

The README now details new directories, improved explanations of test
types (UI, API), and best practices for plugin developers.

---------

Co-authored-by: Cesare de Cal <cesare.decal@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:all-open Backport to all branches that could still receive a release release_note:skip Skip the PR/issue when compiling release notes test:scout v8.19.3 v9.0.6 v9.1.3 v9.2.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants