Skip to content

Commit

Permalink
Document updates (opensearch-project#323)
Browse files Browse the repository at this point in the history
author Charlotte Henkle <henkle@amazon.com> 1615871106 -0700
committer CEHENKLE <henkle@amazon.com> 1615953574 -0700
gpgsig -----BEGIN PGP SIGNATURE-----

 iQGzBAABCAAdFiEEX/CuQ5xIOk0pNjkiruIgsODnx1gFAmBRfqYACgkQruIgsODn
 x1hV6gv/aXar3NmXw4X3uks7eWWobgtuH9vUAIDjurGcBl3PfSQus9hwmnsmfMcc
 LiJY2cU1D1vbqrNnHKqC2aRlA1SXj3xEMPdeMyhPX0Dl01urijvXAW5mAte7Tn+F
 /kK4kcSan552EqPoKnzBUfE3Zia7rriOGF60qGMlZbq2bbQQ2/SfT5WsQrJI2D5k
 IXm062UR6q5pvZfHy1HB/sIFAETv1/knJHyMWv/vH5wmwQvRvue5d30aNK/K60Kz
 G4ALXlehj/Nfv5t16SAB+x65Y9lJ1cBJT98PbT8SCa1ZILjbWFJDwKvFqFQ4kkCD
 QbfzHp3ez4vUrEt9L+p6RmYxxn96VQj1n+2tRlC64sVBvS3qhize85NCBoCSUtRC
 dGyW/fxeILJtgXNfi49WA4UPQ6LaRSnlvAFXogaFeBLYqReLVL6R/HTNvtqDZ4S8
 ZSMs18cFpNq0Lgv2By5Ub0/FBKWQDqe4ydHNK9cdjAEE1wVTTQ2H3X87XPiILrAP
 l4B1Swwr
 =a0jN
 -----END PGP SIGNATURE-----

Adding new templates for bugs, issues and PRs.  Adding new README.  Adding CONTRIBUTING.md and DEVELOPER_GUIDE.md

Signed-off-by: CEHENKLE <henkle@amazon.com>
  • Loading branch information
CEHENKLE authored Mar 17, 2021
1 parent b0f137e commit bacc789
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 219 deletions.
Binary file added .github/ISSUE_TEMPLATE/bug_template.md
Binary file not shown.
Binary file added .github/ISSUE_TEMPLATE/feature_request.md
Binary file not shown.
Binary file not shown.
219 changes: 0 additions & 219 deletions README.asciidoc

This file was deleted.

54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# OpenSearch

Hello!

OpenSearch is an open source search and analytics engine derived from Elasticsearch 7.10.2, and is currently in a pre-alpha state. While we're still in the process of getting set up, we are excited to build the best distributed search engine on the planet with you.

We'll update this page as the state of the project changes, so please check back frequently.

## Current state of the world
We officially began work on the new fork on January 21st, 2021. Since then, we've been removing non-Apache code and doing a full rename of the project. For more details, <add link to blogpost>

### What works

* All references to non-Apache 2.0 code should be removed, and we should be using the new project name everywhere.
* ./gradlew precommit should be passing. Please let us know if you see issues.
* CI/CD with a DCO check.

### What doesn't work

* Unit Tests
* Integration Tests
* Plug-ins

### Guiding Principles

* Great software. If it doesn’t solve a user's problem, everything else is moot. It shall be software you love to use.

* Open source like we mean it. Contributors shall be invested in this being a successful open source project for the long term. It’s all Apache 2.0. There’s no Contributor License Agreement. Easy.

* A level playing field. Contributors shall not tweak the software so that it runs better for any vendor at the expense of others. If this happens, call it out and the contributors shall fix it together as a community.

* Used everywhere. The project goal is for as many people as possible to use it in their business, their software, and their projects. Use it however you want. Surprise the community!

* Made with community input. Project maintainers shall ask for public input on direction, requirements, and implementation for any feature built.

* Open to all contributions. Great open source software is built together, with a diverse community of contributors. If you want to get involved at any level - big, small, or huge - the project maintainers shall find a way to make it happen.

* Respectful, approachable, and friendly. This will be a community where all will be heard, accepted, and valued, whether a new or experienced user or contributor.

* A place to invent and innovate. You will be able to innovate rapidly. This project shall have a stable and predictable foundation that is modular, making it easy to extend.


## How you can help

### Look for the tag "Low Hanging Fruit"

If you're excited to jump in, we've tried to mark a few issues that would be good candidates to get started on. Look for the tag "Low Hanging Fruit" to find them.

### Watch the forum, because there are a bunch of things we want to talk about
As we've been working, we've come up with a bunch of questions that we wanted to get community feedback on. Now that we're done with this first pass of renaming, you'll see us posting those questions to the forum. Please let us know your thoughts!

### Questions? Feedback?

Let us know in the forums.

0 comments on commit bacc789

Please sign in to comment.