🔎 Open source distributed and RESTful search engine.
Go to file
Nick Knize 7c2180ce1a
Update Readme (#433)
This commit corrects the "what doesn't work" section to reflect what doesn't work (removes the Plugin reference, which does work)

Signed-off-by: Nicholas Walter Knize <nknize@apache.org>
2021-03-22 12:56:30 -05:00
.ci [Rename] Refactor CI directory. (#411) 2021-03-21 20:56:34 -05:00
.github fixing encoding on pull_request_template.md 2021-03-17 22:04:17 -07:00
.idea [Rename] Replace more instances of Elasticsearch with OpenSearch. (#432) 2021-03-21 20:56:34 -05:00
benchmarks [Rename] Fix issues for gradle precommit task. (#418) 2021-03-21 20:56:34 -05:00
buildSrc [Rename] Change license header and copyright notice to SPDX (#437) 2021-03-22 12:36:34 -05:00
client Remove lingering instances of Default distribution in favour of Oss (#440) 2021-03-22 10:32:57 -07:00
dev-tools Add script to perform signoff check between commits (#152) 2021-03-13 10:36:15 -06:00
distribution [Rename] Fix env variables and old es maven repo (#439) 2021-03-22 10:17:54 -07:00
gradle [Rename] Change license header and copyright notice to SPDX (#437) 2021-03-22 12:36:34 -05:00
libs [Rename] Replace more instances of Elasticsearch with OpenSearch. (#432) 2021-03-21 20:56:34 -05:00
licenses Remove the Elastic license file, all checks for this license and the license REST APIs. (#12) 2021-03-13 10:36:07 -06:00
modules Remove lingering instances of Default distribution in favour of Oss (#440) 2021-03-22 10:32:57 -07:00
plugins Fix Checkstyle issues. 2021-03-21 20:56:34 -05:00
qa [Rename] Replace more instances of Elasticsearch with OpenSearch. (#432) 2021-03-21 20:56:34 -05:00
rest-api-spec [Rename] Replace more instances of Elasticsearch with OpenSearch. (#432) 2021-03-21 20:56:34 -05:00
server [Rename] Replace more instances of Elasticsearch with OpenSearch. (#432) 2021-03-21 20:56:34 -05:00
test [Rename] Refactoring Elastic references in docker and kerberos builds (#428) (#438) 2021-03-22 09:20:14 -05:00
.dir-locals.el Go back to 140 column limit in .dir-locals.el 2017-04-14 08:50:53 -06:00
.editorconfig Remove default indent from .editorconfig (#49183) 2019-11-18 08:05:53 +00:00
.gitattributes Add a CHANGELOG file for release notes. (#29450) 2018-04-18 07:42:05 -07:00
.gitignore [Rename] Replace more instances of Elasticsearch with OpenSearch. (#432) 2021-03-21 20:56:34 -05:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2021-03-13 10:36:16 -06:00
CONTRIBUTING.md adding two files back in that were lost in the shuffle (#415) 2021-03-19 09:22:10 -05:00
DEVELOPER_GUIDE.md adding two files back in that were lost in the shuffle (#415) 2021-03-19 09:22:10 -05:00
Jenkinsfile Update CI workflow to work on new infra (#123) 2021-03-13 10:36:15 -06:00
LICENSE.txt Update LICENSE.txt 2021-03-22 09:25:46 -05:00
NOTICE.txt Update NOTICE.TXT with OpenSearch copyright (#232) 2021-03-13 10:36:16 -06:00
README.md Update Readme (#433) 2021-03-22 12:56:30 -05:00
TESTING.asciidoc TESTING.asciidoc udpate (#390) 2021-03-19 16:47:35 -07:00
Vagrantfile Remove opensuse 42 from vagrant tests (#63759) 2020-10-15 13:05:46 -07:00
build.gradle [Rename] Replace more instances of Elasticsearch with OpenSearch. (#432) 2021-03-21 20:56:34 -05:00
gradle.properties Explicitly use TLS 1.2 in Gradle (#63880) 2020-10-19 08:57:26 -07:00
gradlew Update gradle wrapper to 6.6 (#59909) (#60949) 2020-08-11 11:03:19 +02:00
gradlew.bat Update gradle wrapper to 6.6 (#59909) (#60949) 2020-08-11 11:03:19 +02:00
settings.gradle [Rename] Fix gradle build as part of the renaming process. (#397) 2021-03-21 20:56:34 -05:00

README.md

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,

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
  • Version Checks

Guiding Principles

  • Great software. If it doesnt 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. Its all Apache 2.0. Theres 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.