Initial commit of codesearch docs

Change-Id: If64f9fef9a98c12a350b568367d376d32a3c4178
This commit is contained in:
Elizabeth K. Joseph 2015-12-14 16:21:55 -08:00
parent 1dd3ba64de
commit 1d0f5815f4
2 changed files with 33 additions and 0 deletions

32
doc/source/codesearch.rst Normal file
View File

@ -0,0 +1,32 @@
:title: Code Search
.. _codesearch:
Code Search
###########
The `Hound <https://github.com/etsy/Hound>`_ code search engine is deployed in
our infrastructure to service all OpenStack repositories.
At a Glance
===========
:Hosts:
* http://codesearch.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-hound/tree/
* :file:`modules/openstack_project/manifests/codesearch.pp`
:Projects:
* https://github.com/etsy/Hound
:Bugs:
* https://storyboard.openstack.org/#!/project/748
* https://github.com/etsy/Hound/issues
:Resources:
* `Hound README <https://github.com/etsy/hound/blob/master/README.md>`_
Overview
========
Hound is configured to read projects from a config.json file that is
automatically generated from the Gerrit projects.yaml, defined in the
$::project_config::jeepyb_project_file variable in Puppet.

View File

@ -37,6 +37,7 @@ Major Systems
apps_site
translate
refstack
codesearch
.. NOTE(dhellmann): These projects were not listed above, or in any
other toctree, which breaks the build. It's not clear why they were