Adds changes to the applies_to page
#1325
Conversation
charlotte-hoblik
added
the
documentation
charlotte-hoblik
changed the title
applies_to pageapplies_to page
There was a problem hiding this comment.
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.
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]>
|
Thank you, @leemthompo for the helpful feedback and suggestions! |
florent-leborgne
requested review from
florent-leborgne,
colleenmcginnis and
shainaraskas
There was a problem hiding this comment.
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.
Co-authored-by: florent-leborgne <[email protected]>
|
Thanks so much for your review @florent-leborgne. I’ve applied your suggestions, really appreciate your help! |
There was a problem hiding this comment.
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.
|
|
||
| ❌ If the product is not versioned (meaning all users are always on the latest version, like in serverless or cloud), you do not need to tag a new GA feature. | ||
|
|
||
| ## Syntax | ||
|
|
There was a problem hiding this comment.
| The `applies_to` metadata supports an [exhaustive list of keys](#structured-model). | |
| When you write or edit documentation, only specify the keys that apply to that content. | |
| Each key accepts values with the following syntax: | |
|
|
||
| ``` | ||
| <life-cycle> [version], <life-cycle> [version] | ||
| ``` | ||
|
|
||
| Taking a mandatory [life-cycle](#life-cycle) with an optional version. | ||
| Taking a mandatory [life-cycle](#life-cycle) with an optional [version](#version). |
There was a problem hiding this comment.
| Taking a mandatory [life-cycle](#life-cycle) with an optional [version](#version). | |
| Where: | |
| - The [life-cycle](#life-cycle) is mandatory | |
| - The [version](#version) is optional | |
| - You can specify multiple states by separating them with a comma. For example: `stack: preview 9.1, ga 9.4` | |
| Note that a key without any value doesn't show any badge in the output. |
|
|
||
| ❌ If the product is not versioned (meaning all users are always on the latest version, like in serverless or cloud), you do not need to tag a new GA feature. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ``` | ||
| <life-cycle> [version], <life-cycle> [version] |
There was a problem hiding this comment.
| <life-cycle> [version], <life-cycle> [version] | |
| <key>: <life-cycle> [version] |
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.