docs: mark AppSec Kit as deprecated (#5949) (CP: v25.3) - #6108
Merged
Merged
Conversation
AppSec Kit won't be available in Vaadin 26. A replacement online service
for Vaadin Enterprise is in progress and is planned to be available
before the Vaadin 26 release, so the AppSec Kit documentation is now
marked as deprecated.
The presentation follows what the other deprecated tools (e.g. Designer)
already use, so readers see a consistent signal:
- **Dismissible caution banner** on every AppSec Kit page — `banner`,
`banner-id: appsec-kit-deprecated` and `banner-style: caution` front
matter on [guilabel]#index#, [guilabel]#Getting Started# and
[guilabel]#Advanced Topics#. The shared `banner-id` means dismissing it
once dismisses it for the whole section.
- **Deprecated badge on each page title** via the
`[deprecated:com.vaadin:vaadin@V25.3]#...#` title macro.
- **Shared warning admonition** defined once in
`articles/tools/appsec/index.adoc` as a `deprecation-notice` tag and
included from the two sub-pages. On the landing page it renders as plain
text below the title; the sub-pages set `:admonition:` so the same text
renders inside a `[WARNING]` block, avoiding a duplicated wording that
could drift.
- **Metadata updates**: the landing page `title` becomes "AppSec Kit
(deprecated)", and `description` / `meta-description` state the
deprecation so it also shows in search results and navigation.
- **Tools overview card** in `articles/tools/index.adoc` is labelled
"AppSec Kit (Deprecated)" and its blurb mentions the upcoming
replacement service.
The wording deliberately uses the future tense ("won't be available in
Vaadin 26") since Vaadin 26 doesn't exist yet.
### Note on the diff
This branch also contains the already-reviewed preview-infrastructure
fix from #5951 (`Dockerfile.preview`,
`dspublisher/theme/init-browser.ts`, `vite.dspublisher.ts`), which
suppresses the cookie-consent dialog on preview deployments. It shows up
here only because `main` hadn't been updated at the time this branch was
merged up; it isn't part of the documentation change under review and
will disappear once `main` is refreshed.
---------
Co-authored-by: totally-not-ai[bot] <290682512+totally-not-ai[bot]@users.noreply.github.com>
Co-authored-by: Artur Signell <artur@vaadin.com>
Contributor
Preview DeploymentThis PR has been deployed for preview. URL: https://docs-preview-pr-6108.fly.dev Changed pagesAdded content is highlighted in green; removed content is marked in red on each page.
Base branch changesNot marked in the preview: v25.3 is a maintenance branch, not a stacked pull request branch. Everything highlighted in the preview belongs to this PR. Built from afbeacf |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.