-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
Create best practices doc in developer guide #94981
Create best practices doc in developer guide #94981
Conversation
- Learn how [EUI tackles accessibility](https://elastic.github.io/eui/#/guidelines/accessibility) | ||
- If you don't use EUI, follow the same EUI accessibility standards | ||
|
||
<DocCallOut title="Internal only"> |
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've been maintaining an internal guide on a11y here: https://github.com/elastic/dev/blob/master/ui/accessibility.md
Should we either consolidate everything here or cross-link to it?
(There's not much in there that is internal-only but some is...)
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.
If this guide is valid at the stack/dev org level, I think it would make sense to move to a new Mission called Elastic Developer Guide
. This would be public. I think it's okay if there is information that is relevant only to internal folks, but not if there is information that needs to be kept internal only. I haven't yet set up this Elastic developer-org wide guide, however.
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.
There are a few sections from the internal best practices doc that aren't included here, that are potentially relevant for external contributors:
- Documentation
- Stability (some of the existing content isn't relevant)
- Testing (some of the existing content isn't relevant)
Were you planning to exclude these docs for the short-term, or is there somewhere else they should go?
@elasticmachine merge upstream @kobelb, excluding for short term only.
|
@elasticmachine merge upstream |
💚 Build SucceededMetrics [docs]
History
To update your PR or re-run it, just comment with: |
* Create best_practies.mdx * Update best_practices.mdx Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Initial content for best practices dev guide section.