-
Notifications
You must be signed in to change notification settings - Fork 27
Restructure doc and add inline examples #1793
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
🔍 Preview links for changed docs |
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.
Nice! ✨ I left some questions, comments, and suggestions below.
Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
…der into update-applies-to-docs
@colleenmcginnis Thanks! Changes applied. |
Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
A specialized `{preview}` role exists to quickly mark something as a technical preview. It takes a required version number | ||
as an argument. | ||
|
||
```markdown | ||
Property {preview}`<version>` | ||
: definition body | ||
``` |
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 like the shortened syntax but I'm wondering if we really want to encourage badges without product keys at this point. I see the benefit, I'm just concerned about output consistency
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.
This was in the original version. I'm OK with removing it.
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.
@colleenmcginnis WDYT?
Fixes #1789