Skip to content
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

Merged
merged 3 commits into from
Mar 23, 2021

Conversation

stacey-gammon
Copy link
Contributor

Initial content for best practices dev guide section.

Screen Shot 2021-03-18 at 4 17 59 PM

@stacey-gammon stacey-gammon changed the title Create best_practies.mdx Create best practices doc in developer guide Mar 18, 2021
@stacey-gammon stacey-gammon marked this pull request as ready for review March 18, 2021 20:19
@stacey-gammon stacey-gammon added auto-backport Deprecated - use backport:version if exact versions are needed release_note:skip Skip the PR/issue when compiling release notes v7.13.0 v8.0.0 labels Mar 18, 2021
@stacey-gammon stacey-gammon requested a review from kobelb March 18, 2021 20:39
- 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">
Copy link
Contributor

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...)

Copy link
Contributor Author

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.

Copy link
Contributor

@kobelb kobelb left a 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?

@stacey-gammon
Copy link
Contributor Author

@elasticmachine merge upstream

@kobelb, excluding for short term only.

  • Documentation
    • I think I'll add a section in best practices, I just wanted to focus on this separately.
  • Stability & Testing
  • This will be a lot of content, I don't think it should be nested inside best practices (aside from some small paragraph to direct folks to more testing docs)

@stacey-gammon
Copy link
Contributor Author

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@stacey-gammon stacey-gammon merged commit 1fc5000 into elastic:master Mar 23, 2021
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Mar 23, 2021
* Create best_practies.mdx

* Update best_practices.mdx

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
@kibanamachine
Copy link
Contributor

💚 Backport successful

7.x / #95253

This backport PR will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request Mar 24, 2021
* Create best_practies.mdx

* Update best_practices.mdx

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Stacey Gammon <gammon@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed DevDocs release_note:skip Skip the PR/issue when compiling release notes v7.13.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants