Skip to content

Adds changes to the applies_to page #1325

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

Merged
merged 25 commits into from
Jun 20, 2025
Merged

Conversation

charlotte-hoblik
Copy link
Contributor

@charlotte-hoblik charlotte-hoblik commented May 30, 2025

Preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/1325/syntax/applies

Update applies_to page to match new versioning guidelines. Removed outdated parts and added missing info.

@charlotte-hoblik charlotte-hoblik self-assigned this May 30, 2025
@charlotte-hoblik charlotte-hoblik requested a review from a team as a code owner May 30, 2025 11:12
@charlotte-hoblik charlotte-hoblik added the documentation Improvements or additions to documentation label May 30, 2025
@charlotte-hoblik charlotte-hoblik marked this pull request as draft May 30, 2025 11:12
@charlotte-hoblik charlotte-hoblik marked this pull request as ready for review May 30, 2025 12:06
@charlotte-hoblik charlotte-hoblik changed the title Adds versioning changes to the applies_to page Adds changes to the applies_to page May 30, 2025
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

Thanks @charlotte-hoblik your changes about the updates look great, I just think we should take the opportunity to improve the overall structure of the page now that the information is more mature. I didn't give this a 100% thorough review, but should be enough to build upon your work.

@leemthompo
Copy link
Contributor

@charlotte-hoblik I think we could improve the flow in the Syntax section, namely by moving lifecycle up higher:

  • Basic pattern
  • Life cycle
  • Version
  • Combined states

@charlotte-hoblik
Copy link
Contributor Author

charlotte-hoblik commented Jun 3, 2025

Thank you, @leemthompo for the helpful feedback and suggestions!
Heads-up: the examples are still a work in progress, with more updates coming.

Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

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

Thank you thank you @charlotte-hoblik
Your changes already make this page so much better. 🙇

I'm leaving some comments that are mostly small clarifications or suggestions to add more overall context to the core purpose of these applies_to tag.

@charlotte-hoblik
Copy link
Contributor Author

Thanks so much for your review @florent-leborgne. I’ve applied your suggestions, really appreciate your help!

@florent-leborgne florent-leborgne self-requested a review June 16, 2025 10:34
@charlotte-hoblik charlotte-hoblik requested a review from a team as a code owner June 17, 2025 06:32
Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

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

Thank you Charlotte this is great!

I left a few more suggestions to clarify the syntax part. It's out of the scope of your work here but since we're at it... :)

We should wait until all of these changes are fully implemented by Docs Engineering to merge this PR, to avoid any error.

@florent-leborgne
Copy link
Contributor

FYI this is the PR that implements the updated lifecycle statuses (when it's merged we can merge this one)

charlotte-hoblik and others added 3 commits June 20, 2025 12:44
Co-authored-by: florent-leborgne <[email protected]>
Co-authored-by: florent-leborgne <[email protected]>
Co-authored-by: florent-leborgne <[email protected]>
@georgewallace
Copy link
Contributor

@charlotte-hoblik @florent-leborgne the dependent PR has now been merged. FYI

@charlotte-hoblik charlotte-hoblik enabled auto-merge (squash) June 20, 2025 14:04
@charlotte-hoblik charlotte-hoblik merged commit e3a3d1c into main Jun 20, 2025
15 checks passed
@charlotte-hoblik charlotte-hoblik deleted the charlotte-applies-to branch June 20, 2025 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants