-
Notifications
You must be signed in to change notification settings - Fork 33
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
base: main
Are you sure you want to change the base?
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? |
| font-size: 13px; | ||
| `} | ||
| > | ||
| The functionality described here is: |
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.
I think we could remove this line @elastic/docs-tech-leads @vishaangelova, do you think it's very valuable?
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.
+1
|
|
||
| // Deployment Types | ||
| [VersioningSystemId.Ess] = new ProductInfo( | ||
| Description: "<strong>Elastic Cloud Hosted</strong> is a deployment of the Elastic Stack that's hosted on Elastic Cloud.", |
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.
@elastic/docs-tech-leads @vishaangelova can you think of other ways to describe ECH? I think in this form it may be a little confusing, maybe some small tweak like this?
| Description: "<strong>Elastic Cloud Hosted</strong> is a deployment of the Elastic Stack that's hosted on Elastic Cloud.", | |
| Description: "<strong>Elastic Cloud Hosted</strong> lets you manage and configure your own deployments of the Elastic Stack, hosted on Elastic Cloud.", |
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.
what is the confusion we're trying to solve for? is it the fact that ECH is versionless and stack is not?
any definition will cause a little confusion because the ECH label also gets applied to the elastic cloud context (just like the ECE label gets applied to the orchestrator context as well as the deployment context).
ultimately, a hosted deployment is just a deployment of the Elastic Stack that's hosted on Elastic Cloud., as originally stated in the definition, and it's elastic cloud that is doing the management and configuration, even though it does it a little differently for ech/serverless/ccm.
I personally would leave the original definition for now ... one thing i want to possibly address in the metadata refactor is separating ECH and Serverless from Elastic Cloud which might make this better
does this help?
| Description: "<strong>Elastic Cloud Hosted</strong> is a deployment of the Elastic Stack that's hosted on Elastic Cloud.", | |
| Description: "<strong>Elastic Cloud Hosted</strong> is a deployment of the versioned Elastic Stack that's hosted on Elastic Cloud.", |
florent-leborgne
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.
This is all very nice - There are a few fairly minor things I'm wondering about after testing - I captured those in https://docs.google.com/document/d/1SWPnaia5I7XL5QcyZ_NUDOgn07xB43SPHjTsUW6OFLY/edit?tab=t.0
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
A new
VersionSpecclass has been created. It builds on SemVersion, and supports the following versioning types:9.5.0, 9.5.1, 9.5.6 -> all display as 9.5 or 9.5+
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.
Implemented validation in
ApplicableToYamlConverter: