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

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

Conversation

charlotte-hoblik
Copy link

@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.

security: unavailable
elasticsearch: beta
observability: deprecated
product: preview 9.5, deprecated 9.7
---

# Applies to
Copy link
Contributor

@leemthompo leemthompo May 30, 2025

Choose a reason for hiding this comment

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

I think we can restructure the page now that we have more info and have more logical progression:

Something like:

  1. Intro
  2. Syntax
  3. When and where to use applies_to ← new grouped section
  • Intro/explain that each level has slightly different syntax.
  • Mention stuff currently in 'when to use'
  • Levels:
    • Page-level (required)
    • Section-level
    • Inline
  1. Structured model (Maybe could have better heading name like "Metadata structure" or something)
  2. Examples

I'm not married to any specific ordering here apart from having more context and explanations up top. :)

Copy link
Contributor

Choose a reason for hiding this comment

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

and maybe we can weave examples into other sections and remove the standalone examples #maybe

Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
@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

Co-authored-by: Liam Thompson <[email protected]>
charlotte-hoblik and others added 2 commits June 2, 2025 15:08
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
@charlotte-hoblik
Copy link
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.

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.

2 participants