From cc7624d37643a96222e7c0777a625b72623c3d46 Mon Sep 17 00:00:00 2001
From: Pawel Wieczorek
Date: Tue, 17 Dec 2019 15:30:18 +0100
Subject: Describe purpose of Hound code search environment
Issue-ID: ONAPARC-540
Change-Id: Ie7db4cb6925501fd44dc0372f0a1305463a7e7cc
Signed-off-by: Pawel Wieczorek
---
bootstrap/README.md | 1 +
bootstrap/codesearch/README.rst | 17 +++++++++++++++++
2 files changed, 18 insertions(+)
create mode 100644 bootstrap/codesearch/README.rst
(limited to 'bootstrap')
diff --git a/bootstrap/README.md b/bootstrap/README.md
index 28f4977c6..7809abf02 100644
--- a/bootstrap/README.md
+++ b/bootstrap/README.md
@@ -7,5 +7,6 @@
## Sub-components
+* codesearch - A set of vagrant scripts that will set up Hound daemon configured to search through all ONAP repositories.
* jenkins - A set of vagrant scripts that will set up a simple Jenkins environment with jobs configured to build all ONAP java code and docker images.
* vagrant-minimal-onap - A set of vagrant scripts that will set up minimal ONAP environment for research purposes.
diff --git a/bootstrap/codesearch/README.rst b/bootstrap/codesearch/README.rst
new file mode 100644
index 000000000..8e3278d36
--- /dev/null
+++ b/bootstrap/codesearch/README.rst
@@ -0,0 +1,17 @@
+============================================
+ ONAP Integration > Bootstrap > Code search
+============================================
+
+This directory contains a set of Vagrant scripts that will automatically set up a Hound_ instance
+with config generator to index all ONAP code.
+
+This is intended to show a beginning ONAP developer how to set up and configure an environment that
+allows to search through ONAP code repositories quickly. It is not intended to be used as
+a production code search solution.
+
+`Upstream Docker image` has not been used due to lack of project activity. This environment
+(together with daemon configuration generator) might be migrated to a new Docker image recipe in
+future, though.
+
+.. _Hound: https://github.com/hound-search/hound
+.. _`Upstream Docker image`: https://hub.docker.com/r/etsy/hound
--
cgit 1.2.3-korg