Skip to content

[do not merge] check multi value applies-to and lists #4431

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

Jump to bottom
Open
florent-leborgne wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[do not merge] check multi value applies-to and lists #4431

florent-leborgne wants to merge 3 commits into from

Conversation

@florent-leborgne
Copy link
Contributor

@florent-leborgne florent-leborgne commented Dec 19, 2025 •
edited
Loading

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

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

@florent-leborgne florent-leborgne requested review from a team as code owners December 19, 2025 15:49
@github-actions
Copy link
Contributor

github-actions bot commented Dec 19, 2025 •
edited
Loading

Vale Linting Results

Summary: 5 suggestions found

💡 Suggestions (5)
File Line Rule Message
deploy-manage/production-guidance/optimize-performance/approximate-knn-search.md 130 Elastic.Acronyms 'HNSW' has no definition.
explore-analyze/elastic-inference/eis.md 20 Elastic.Acronyms 'ELSER' has no definition.
explore-analyze/report-and-share/automating-report-generation.md 267 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.
troubleshoot/ingest/opentelemetry/edot-collector/trace-export-errors.md 34 Elastic.EmDashes Don't put a space before or after a dash.
troubleshoot/ingest/opentelemetry/edot-collector/trace-export-errors.md 34 Elastic.FutureTense 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now.

@florent-leborgne florent-leborgne mentioned this pull request Dec 19, 2025
Open
@github-actions
Copy link
Contributor

github-actions bot commented Dec 19, 2025 •
edited
Loading

🔍 Preview links for changed docs

More links …

@benironside
Copy link
Contributor

benironside commented Dec 19, 2025

@florent-leborgne I'll ask the same question as I did on #4429, what kind of reviews do you want on this? It's not the typical PR so I'm just thinking about how best to go about it 🕵️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@florent-leborgne @benironside