-
Notifications
You must be signed in to change notification settings - Fork 18
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
base: main
Are you sure you want to change the base?
Conversation
applies_to
pageapplies_to
page
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 @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 |
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 can restructure the page now that we have more info and have more logical progression:
Something like:
- Intro
- Syntax
- 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
- Structured model (Maybe could have better heading name like "Metadata structure" or something)
- Examples
I'm not married to any specific ordering here apart from having more context and explanations up top. :)
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.
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]>
@charlotte-hoblik I think we could improve the flow in the Syntax section, namely by moving lifecycle up higher:
|
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Thank you, @leemthompo for the helpful feedback and suggestions! |
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.