Skip to content

[Scout] Improve Scout Deployment tags article#260229

Merged
csr merged 2 commits intoelastic:mainfrom
csr:scout-docs-tags-improvements
Mar 30, 2026
Merged

[Scout] Improve Scout Deployment tags article#260229
csr merged 2 commits intoelastic:mainfrom
csr:scout-docs-tags-improvements

Conversation

@csr
Copy link
Copy Markdown
Member

@csr csr commented Mar 30, 2026

This PR improves the existing Deployment tags article to add some less obvious details on how tags work in Scout. Find more details in the comments below.

@csr csr self-assigned this Mar 30, 2026
@csr csr added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting labels Mar 30, 2026
);
```

This test will only run locally (stateful classic and serverless Security complete tier), and will be skipped by Elastic Cloud pipelines.
Copy link
Copy Markdown
Member Author

@csr csr Mar 30, 2026

Choose a reason for hiding this comment

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

New: we now show developers how they can exclude their tests from running on Elastic Cloud.

Comment on lines +24 to +30
test.describe(
'My suite',
{ tag: [...tags.stateful.classic, ...tags.serverless.security.complete] },
() => {
// ...
});
});
}
);
Copy link
Copy Markdown
Member Author

@csr csr Mar 30, 2026

Choose a reason for hiding this comment

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

Updated: we show an example using a set of combination of tags teams are very likely to use (tags.deploymentAgnostic is mostly reserved for Platform tests that need to run on all stateful + serverless complete project types). We update our guidance on deployment tags to stop mentioning "we recommend it in most cases".

| ----------------------------------------------- | ---------------------------------------------------------- |
| `tags.serverless.observability.complete` | {icon}`logo_observability` Observability (complete) |
| `tags.serverless.observability.logs_essentials` | {icon}`logo_observability` Observability (logs_essentials) |
| `tags.serverless.observability.all` | {icon}`logo_observability` All Observability project tiers |
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Add missing: tags.serverless.observability.all

| `tags.serverless.security.ease` | {icon}`logo_security` Security (ease) |
| Helper | Project type |
| ------------------------------------- | ------------------------------------------------ |
| `tags.serverless.security.all` | {icon}`logo_security` All Security project tiers |
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Add missing: tags.serverless.security.all

| `tags.stateful.observability` | {icon}`logo_observability` Observability |
| `tags.stateful.security` | {icon}`logo_security` Security |

The target solution view indicates the **solution view** the test is intended for, but is not enforced at test execution time. To set the solution view in a test, use `scoutSpace.setSolutionView()`.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

New: we explain what the solution portion of stateful tags refers to the Kibana Space-specific "target solution view" the tests are compatible with.

@csr csr marked this pull request as ready for review March 30, 2026 11:50
@csr csr requested a review from a team as a code owner March 30, 2026 11:50
| ----------------------------- | ------------------------------------------ |
| `tags.serverless.workplaceai` | {icon}`logo_workplace_search` Workplace AI |

### `tags.performance` [scout-deployment-tags-performance]
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Move to the bottom as performance tags aren't as popular as the other tags listed above.

@elasticmachine
Copy link
Copy Markdown
Contributor

💚 Build Succeeded

cc @csr

@csr csr enabled auto-merge (squash) March 30, 2026 12:33
@csr csr merged commit fabc59d into elastic:main Mar 30, 2026
16 checks passed
@csr csr deleted the scout-docs-tags-improvements branch March 30, 2026 12:55
jeramysoucy pushed a commit to jeramysoucy/kibana that referenced this pull request Apr 1, 2026
This PR improves the existing [Deployment
tags](https://www.elastic.co/docs/extend/kibana/scout/deployment-tags)
article to add some less obvious details on how tags work in Scout. Find
more details in the comments below.
paulinashakirova pushed a commit to paulinashakirova/kibana that referenced this pull request Apr 2, 2026
This PR improves the existing [Deployment
tags](https://www.elastic.co/docs/extend/kibana/scout/deployment-tags)
article to add some less obvious details on how tags work in Scout. Find
more details in the comments below.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip This PR does not require backporting release_note:skip Skip the PR/issue when compiling release notes v9.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants