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

[Docs] Update README to baseline to project standards #382

Merged
merged 3 commits into from
Feb 27, 2023

Conversation

joshuarrrr
Copy link
Member

@joshuarrrr joshuarrrr commented Feb 21, 2023

Description

baselined against https://github.com/opensearch-project/.github

  • Add ADMINS.md
  • Update DEVELOPER_GUIDE.md - move running instructions from README.md, remove doc site links
  • Add RESPONSIBILITIES.md
  • Add SECURITY.md

Issues Resolved

#103

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.

- Add ADMINS.md
- Update DEVELOPER_GUIDE.md - move running instructions from README.md, remove doc site links
- Add RESPONSIBILITIES.md
- Add SECURITY.md

Signed-off-by: Josh Romero <[email protected]>
@joshuarrrr joshuarrrr requested a review from a team as a code owner February 21, 2023 22:09
@kavilla kavilla linked an issue Feb 23, 2023 that may be closed by this pull request
Copy link
Contributor

@seanneumann seanneumann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice.

@seanneumann seanneumann merged commit 03adf4d into opensearch-project:main Feb 27, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request Feb 27, 2023
- Add ADMINS.md
- Update DEVELOPER_GUIDE.md - move running instructions from README.md, remove doc site links
- Add RESPONSIBILITIES.md
- Add SECURITY.md

Signed-off-by: Josh Romero <[email protected]>
Co-authored-by: Sean Neumann <[email protected]>
(cherry picked from commit 03adf4d)
BSFishy pushed a commit that referenced this pull request Feb 27, 2023
- Add ADMINS.md
- Update DEVELOPER_GUIDE.md - move running instructions from README.md, remove doc site links
- Add RESPONSIBILITIES.md
- Add SECURITY.md

Signed-off-by: Josh Romero <[email protected]>
Co-authored-by: Sean Neumann <[email protected]>
(cherry picked from commit 03adf4d)

Co-authored-by: Josh Romero <[email protected]>
@joshuarrrr joshuarrrr deleted the docs/readme-cleanup branch March 4, 2023 00:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(OUI Docs) Readme.md
3 participants