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

Update and add documentation files #38

Merged
merged 3 commits into from
Jun 24, 2021

Conversation

ohltyler
Copy link
Member

@ohltyler ohltyler commented Jun 24, 2021

Signed-off-by: Tyler Ohlsen ohltyler@amazon.com

Description

This PR standardizes some existing docs, and adds some new ones, to meet the repository standards listed here.

Changes include:

  • Linking to standardized CONTIBUTING doc
  • Refactoring env setup / build / test etc. into a DEVELOPER_GUIDE doc
  • Standardizing MAINTAINERS
  • Adding OpenSearch logo + cleaning up README
  • Add standardized RELEASING
  • Add standardized SECURITY

Note: ADMINS file is not added yet - this will be done by the admins themselves.

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
@ohltyler ohltyler added documentation Improvements or additions to documentation v1.0.0 Version 1.0.0 v1.1.0 Version 1.1.0 labels Jun 24, 2021
@ohltyler ohltyler requested review from kaituo, ylwu-amzn and spbjss June 24, 2021 16:53
@ohltyler ohltyler merged commit 8919c8f into opensearch-project:main Jun 24, 2021
@ohltyler ohltyler deleted the update-docs branch June 24, 2021 19:45
ohltyler added a commit to ohltyler/anomaly-detection-dashboards-plugin-1 that referenced this pull request Jun 24, 2021
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
ohltyler added a commit to ohltyler/anomaly-detection-dashboards-plugin-1 that referenced this pull request Jun 24, 2021
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
ohltyler added a commit that referenced this pull request Jun 24, 2021
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
ohltyler added a commit that referenced this pull request Jun 24, 2021
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v1.0.0 Version 1.0.0 v1.1.0 Version 1.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants