-
Notifications
You must be signed in to change notification settings - Fork 34
Applies_to: Expand versioning features #2322
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.
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
Conversation
…r applicabilities
🔍 Preview links for changed docs |
…out a specified version
reakaleek
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are two test cases that made me curious.
Otherwise, LGTM.
Nice work.
| "sub_type": "stack", | ||
| "lifecycle": "ga", | ||
| "version": "9999.9999.9999" | ||
| "version": "all" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
➕ thanks for fixing this and making it properly.
|
I'm wondering a bit why there are so many warnings. What's the reason we can't do this backwards compatible? |
| { | ||
| // Stack | ||
| [VersioningSystemId.Stack] = new ProductInfo( | ||
| Description: "The <strong>Elastic Stack</strong> includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Maybe this isn't the right place to discuss this, so feel free to ignore...]
IMO the goal here is to display/explain the stack-versioning scheme, which applies to more products than this, so not sure if this is a helpful spot for this particular definition.
In the rendered part, I'd vote for removing "Stack" entirely and simply displaying the version.
For the Description, I'd say something like "Stack-versioned products and features follow the same semantic versioning scheme as Elasticsearch and Kibana."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Long debate on this one, we want to change this term soon. For now we'll stick with this, with the goal of explaining what "Stack" means to address some direct feedback. For the versioning model, we'll now always show a version in those badges, which should clarify a lot the intent of these badges wrt versioning
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair enough, I'd insist, at least, that the current Description isn't super helpful in this context but 🤷
src/Elastic.Documentation.Site/Assets/web-components/AppliesToPopover.tsx
Show resolved
Hide resolved
|
I love this update. Very excited to see version ranges coming to fruition, and I like the validation layer and the popover updates. Thank you! |
…e notes in the popover
# Conflicts: # tests/authoring/Applicability/ApplicableToComponent.fs
## Summary This PR: - adjusts applies-switch occurrences in this repo while planning for upcoming syntax changes. - adjusts the order of items to have them ordered from latest to oldest when relevant This PR should only be merged after elastic/docs-builder#2322 is merged. CI should fail until then. Contributes to: #4361 ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [ ] Yes - [x] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> --------- Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com> Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
## Summary This PR: - checks multi-value applies_to keys wrt the upcoming syntax changes - checks list items with applies_to to make sure they convey the right information (i.e. were they alternative versions or independently announcing product availability) - and puts latest first in such lists when this wasn't the case - checks that patch-level information that is different than `.0` can stay as is, or make necessary adjustments if not. Note: the `+` notation is a best practice but isn't mandatory, so this PR does not update every single occurrence of applies_to that we have, and instead focuses on cases with ambiguity or that could have led to issues with the updates This PR should only be merged after elastic/docs-builder#2322 is merged. CI should fail until then. Contributes to: #4361 ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [ ] Yes - [x] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> --------- Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: Nastasha Solomon <nastasha.solomon@elastic.co>
## Summary This PR converts tabs that should now be applies-switch thanks to the recent and upcoming updates to the metadata system. This PR should only be merged after elastic/docs-builder#2322 is merged. CI should fail until then. Contributes to: #4361 ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [ ] Yes - [x] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> --------- Co-authored-by: Visha Angelova <91186315+vishaangelova@users.noreply.github.com>
Related to elastic/docs-builder#2135 and elastic/docs-builder#2322 and <!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary - [x] Update existing cumulative docs contributing guidelines - [x] Add examples that include ranges - [x] Update get started content as needed ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [ ] Yes - [x] No cc @florent-leborgne @vishaangelova @shainaraskas --------- Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
This PR provides a set of adjustments to the inner workings of versioning in the context of applies_to. This draft will be further updated with front-end changes, but badge-related changes can be checked independently.
It is part of #2135.
Problem description
Describing versions within applicability contains several quirks and limitations, such as:
Proposed changes
Version Specification (VersionSpec)
A new
VersionSpecclass has been created. It builds on SemVersion, and supports the following versioning types:Simplified Badge Display
9.5.0, 9.5.1, 9.5.6 -> all display as 9.5 or 9.5+
Base Version Display
When no version is specified for versioned products, the base version is now shown:
Before:
stack: ga-> Badge shows just "Stack"After:
stack: ga-> Badge shows "Stack│8.0+" (assuming base = 8.0)Unversioned products continue to show no version.
Validation Rules
Implemented validation in
ApplicableToYamlConverter:Tooltip -> Popover overhaul
The badge tooltip was replaced by a popover component.