Skip to content

Adds table to dynamic tag logic explanation #1749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Adds table to dynamic tag logic explanation #1749

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8b6915e
Adds table to dynamic tag logic explanation.
szabosteve Aug 18, 2025
acd0848
Relocates table.
szabosteve Aug 19, 2025
eccb5bb
Fixes syntax.
szabosteve Aug 19, 2025
7cdd132
Fine-tunes tag.
szabosteve Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/contribute/_snippets/tag-processing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Specifically for versioned products, badges will display differently when the `a
* `Deprecation planned` (if the lifecycle is deprecated)

Example: {applies_to}`stack: deprecated 99.99`
* `Removal planned` (if the lifecycle is removed)
* `Removal planned` (if the lifecycle is removed)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd remove these bullets in favor of the table below + kind of rework the content so it's introducing the table instead


Example: {applies_to}`stack: removed 99.99`

Expand All @@ -18,3 +18,18 @@ When multiple lifecycle statuses and versions are specified in the sources, seve
:::{note}
Visuals and wording in the output documentation are subject to changes and optimizations.
:::
Comment on lines 18 to 20
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd also move this note down to the bottom


The following table shows how the badge text and corresponding tooltip text vary by release status for each lifecycle value. Hoover over the example badges for tooltip text.

| Lifecycle | Release status | Badge text |
|-------------|----------------|-----------------------------------------------------------------------------------|
| preview | prerelease | Planned |
Copy link
Contributor

Choose a reason for hiding this comment

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

these can have examples too. just set the version to 99.99

| | post-release | `<KEY> PREVIEW <VERSION>` <br><br> example: {applies_to}`stack: preview 9.1` |
| beta | prerelease | Planned |
| | post-release | `<KEY> BETA <VERSION>` <br><br> example: {applies_to}`stack: beta 9.1` |
| ga | prerelease | Planned |
| | post-release | `<KEY> <VERSION>` <br><br> example: {applies_to}`stack: ga 9.1` |
| deprecated | prerelease | Deprecation planned |
| | post-release | `<KEY> DEPRECATED <VERSION>` <br><br> example: {applies_to}`stack: deprecated 9.1`|
| removed | prerelease | Removal planned |
| | post-release | `<KEY> REMOVED <VERSION>` <br><br> example: {applies_to}`stack: removed 9.1` |
Loading