-
Notifications
You must be signed in to change notification settings - Fork 32
Update stepper.md #1603
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
Update stepper.md #1603
Conversation
🔍 Preview links for changed docs |
docs/syntax/stepper.md
Outdated
| to break down processes into manageable stages. For example, you can usee steppers instead of numbered | ||
| section headings when documenting a supertask or a complex procedure. An example is the [Observability Get Started](https://www.elastic.co/docs/solutions/observability/get-started). |
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.
Is the intention to replace all numbered steps (ordered lists) with steppers? Or do they each have their place based on certain characteristics?
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.
Good question. No, no intention to replace ordered lists. I think both have their place, but this would be better described, I think, in a style guide; in the end this documentation is concerned with how the component works, not with how it should be used in Elastic documentation (Docs Builder is an open source docs tool that anyone could use). Here we can suggest, but I don't think we can be prescriptive.
+CC @bmorelli25, as we were talking of style guide consolidation earlier today.
bmorelli25
left a comment
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 agree that this isn't the spot for prescriptive guidance. This LGTM in the short term.
|
I was thinking short-term as well, while everything is new. |
Elaborates a bit on the example