docs: Split README content into more files

Many Gerrit plugin admins/devs expect to find most docs in
src/main/resources/Documentation/ but we also want to have a useful
top-level README. Support both cases by moving some README content into
individual Documentation/ files and linking to it from the README and
other Documentation/ files.

Also fix typos in several of the docs.

Change-Id: I8b218d06758dbd19d04bce0c7a6d4ea4cbd6bc89
5 files changed
tree: b137a9e882b00f9bf538af595cb28afb020ad5dc
  1. src/
  2. BUILD
  3. external_plugin_deps.bzl
  4. Jenkinsfile
  5. LICENSE
  6. README.md
README.md

Index backend for Gerrit, based on ElasticSearch

Indexing backend libModule for Gerrit Code Review based on ElasticSearch.

This module was originally part of Gerrit core and then extracted into a separate component from v3.5.0-rc3 as part of Change-Id: Ib7b5167ce.

How to build

This libModule is built like a Gerrit in-tree plugin, using Bazelisk. See the build instructions for more details.

Setup

See the setup instructions for how to install the index-elasticsearch module.

For further information and supported options, refer to the config documentation.

Integration test

This libModule runs tests like a Gerrit in-tree plugin, using Bazelisk. See the test instructions for more details.