docs

DEVELOPMENT.md

@@ -8,37 +8,6 @@ See README for this version until a GA release.
 1. Use Python 3.4+
 2. We advise that you create a virtual environment for this project.
 
-## TESTING
-
-1. ``/tests/scripts`` contains ``start_clusters.sh`` which will start up 3 ES clusters on ports 9200, 8200, 7200. These are versions 2.x, 5.x, and 6.x respectively.
-2. Edit ``start_clusters.sh`` to point to your local ES binaries.
-3. Source the virtual environment:
-```sh
-source ../environments/elastichq/bin/activate
-```
-4. To run tests:
-```sh
-elastichq/run_tests
-```
-
-### Notes
-
-* Coverage report will be appear under ``/tests/cover``.
-* All tests will fail without those 3 clusters running. They are the 3 major versions that HQ currently supports. 
-* The scripts under ``/tests/scripts`` allow for starting, stopping, and listing all clusters. You will need to edit those for the tests to run.
-
-## Building Documentation
-
-``./sphinx-build -b html /path/to/docs/source /path/to/docs``
-
-## DISTRIBUTION
-
-
-To build the final distribution that will have the UI and API accessible from port 5000, run `npm run-script build`.
-
-This will create an `index.html` that the Flask server will serve, under `/elastichq/templates` and static file bundles under `/elastichq/static`.
-
-Once the distribution is built, you can start the server with `python application.py` and view the application at http://localhost:5000
 
 ## CHANGELOG
 

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2013, Roy Russo
+Copyright 2013-2018, Roy Russo
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

README.md

@@ -12,6 +12,17 @@ Simplified Monitoring and Management for ElasticSearch clusters.
 
 ![alt text](main_dashboard.png)
 
+
+Key Features
+------------
+* Monitor **many** clusters at once.
+* Monitor Nodes, Indices, Shards, and general cluster metrics.
+* Create and perform maintenance on Elasticsearch Indices.
+* One-Click access to common ES API endpoints.
+* Well-documented REST API for extensibility.
+* Active project used by Fortune 100 companies around the world.
+* Free. ;-)
+
 Requirements
 ------------
 
@@ -21,6 +32,8 @@ Requirements
 Installation
 ------------
 
+For **full** installation and configuration instructions, see [Getting Started](http://docs.elastichq.org/installation.html)
+
 1. Download or clone the repository. 
 2. Open terminal and point to root of repository. Type: ``pip install -r requirements.txt``
 3. Run server with: `` python application.py ``. Alternatively: ``./manage.py runserver``

docs/_sources/developer-guide.txt

@@ -37,6 +37,36 @@ This will create an ``index.html`` that the Flask server will serve, under ``/el
 
 Once the distribution is built, you can start the server with ``python application.py`` and view the application at ``http://localhost:5000``
 
+Running Tests
+-------------
+
+1. ``/tests/scripts`` contains ``start_clusters.sh`` which will start up 3 ES clusters on ports 9200, 8200, 7200. These are versions 2.x, 5.x, and 6.x respectively.
+2. Edit ``start_clusters.sh`` to point to your local ES binaries.
+3. Source the virtual environment:
+
+.. code-block:: bash
+
+    source ../environments/elastichq/bin/activate
+
+4. To run tests:
+
+.. code-block:: bash
+
+    elastichq/run_tests
+
+
+Notes
+~~~~~
+
+* Coverage report will be appear under ``/tests/cover``.
+* All tests will fail without those 3 clusters running. They are the 3 major versions that HQ currently supports.
+* The scripts under ``/tests/scripts`` allow for starting, stopping, and listing all clusters. You will need to edit those for the tests to run.
+
+Building Documentation
+----------------------
+
+``./sphinx-build -b html /path/to/docs/source /path/to/docs``
+
 HTTP Responses
 --------------
 
@@ -78,3 +108,4 @@ Issues/Bugs
 
 Patches, bug reports, and feature requests are all welcome through the `GitHub site
 <https://github.com/ElasticHQ/elasticsearch-HQ/>`_. Contributions in the form of patches or pull requests are easier to integrate and will receive priority attention.
+

docs/developer-guide.html

@@ -88,6 +88,11 @@ <h2>Table Of Contents</h2>
 <li class="toctree-l3"><a class="reference internal" href="#building-a-distribution">Building a Distribution</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="#running-tests">Running Tests</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#building-documentation">Building Documentation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#http-responses">HTTP Responses</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#http-status">HTTP Status</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#response-headers">Response Headers</a></li>
@@ -140,12 +145,17 @@ <h1>For Developers<a class="headerlink" href="#for-developers" title="Permalink
 <li><a class="reference internal" href="#building-a-distribution" id="id3">Building a Distribution</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#http-responses" id="id4">HTTP Responses</a><ul>
-<li><a class="reference internal" href="#http-status" id="id5">HTTP Status</a></li>
-<li><a class="reference internal" href="#response-headers" id="id6">Response Headers</a></li>
+<li><a class="reference internal" href="#running-tests" id="id4">Running Tests</a><ul>
+<li><a class="reference internal" href="#notes" id="id5">Notes</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#building-documentation" id="id6">Building Documentation</a></li>
+<li><a class="reference internal" href="#http-responses" id="id7">HTTP Responses</a><ul>
+<li><a class="reference internal" href="#http-status" id="id8">HTTP Status</a></li>
+<li><a class="reference internal" href="#response-headers" id="id9">Response Headers</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#issues-bugs" id="id7">Issues/Bugs</a></li>
+<li><a class="reference internal" href="#issues-bugs" id="id10">Issues/Bugs</a></li>
 </ul>
 </div>
 <div class="section" id="building-pre-releases">
@@ -174,10 +184,39 @@ <h3><a class="toc-backref" href="#id3">Building a Distribution</a><a class="head
 <p>Once the distribution is built, you can start the server with <code class="docutils literal"><span class="pre">python</span> <span class="pre">application.py</span></code> and view the application at <code class="docutils literal"><span class="pre">http://localhost:5000</span></code></p>
 </div>
 </div>
+<div class="section" id="running-tests">
+<h2><a class="toc-backref" href="#id4">Running Tests</a><a class="headerlink" href="#running-tests" title="Permalink to this headline">¶</a></h2>
+<ol class="arabic simple">
+<li><code class="docutils literal"><span class="pre">/tests/scripts</span></code> contains <code class="docutils literal"><span class="pre">start_clusters.sh</span></code> which will start up 3 ES clusters on ports 9200, 8200, 7200. These are versions 2.x, 5.x, and 6.x respectively.</li>
+<li>Edit <code class="docutils literal"><span class="pre">start_clusters.sh</span></code> to point to your local ES binaries.</li>
+<li>Source the virtual environment:</li>
+</ol>
+<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="nb">source</span> ../environments/elastichq/bin/activate
+</pre></div>
+</div>
+<ol class="arabic simple" start="4">
+<li>To run tests:</li>
+</ol>
+<div class="highlight-bash"><div class="highlight"><pre><span></span>elastichq/run_tests
+</pre></div>
+</div>
+<div class="section" id="notes">
+<h3><a class="toc-backref" href="#id5">Notes</a><a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h3>
+<ul class="simple">
+<li>Coverage report will be appear under <code class="docutils literal"><span class="pre">/tests/cover</span></code>.</li>
+<li>All tests will fail without those 3 clusters running. They are the 3 major versions that HQ currently supports.</li>
+<li>The scripts under <code class="docutils literal"><span class="pre">/tests/scripts</span></code> allow for starting, stopping, and listing all clusters. You will need to edit those for the tests to run.</li>
+</ul>
+</div>
+</div>
+<div class="section" id="building-documentation">
+<h2><a class="toc-backref" href="#id6">Building Documentation</a><a class="headerlink" href="#building-documentation" title="Permalink to this headline">¶</a></h2>
+<p><code class="docutils literal"><span class="pre">./sphinx-build</span> <span class="pre">-b</span> <span class="pre">html</span> <span class="pre">/path/to/docs/source</span> <span class="pre">/path/to/docs</span></code></p>
+</div>
 <div class="section" id="http-responses">
-<h2><a class="toc-backref" href="#id4">HTTP Responses</a><a class="headerlink" href="#http-responses" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id7">HTTP Responses</a><a class="headerlink" href="#http-responses" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="http-status">
-<h3><a class="toc-backref" href="#id5">HTTP Status</a><a class="headerlink" href="#http-status" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id8">HTTP Status</a><a class="headerlink" href="#http-status" title="Permalink to this headline">¶</a></h3>
 <p>All response codes are included in the HTTP Status response header. There are method-specific responses to take note of:</p>
 <ul class="simple">
 <li>POST - Returns <code class="docutils literal"><span class="pre">201</span></code></li>
@@ -186,7 +225,7 @@ <h3><a class="toc-backref" href="#id5">HTTP Status</a><a class="headerlink" href
 </ul>
 </div>
 <div class="section" id="response-headers">
-<h3><a class="toc-backref" href="#id6">Response Headers</a><a class="headerlink" href="#response-headers" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id9">Response Headers</a><a class="headerlink" href="#response-headers" title="Permalink to this headline">¶</a></h3>
 <p>Standard header response below:</p>
 <div class="highlight-http"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
 <span class="na">Access-Control-Allow-Credentials</span><span class="o">:</span> <span class="l">true</span>
@@ -209,7 +248,7 @@ <h3><a class="toc-backref" href="#id6">Response Headers</a><a class="headerlink"
 </div>
 </div>
 <div class="section" id="issues-bugs">
-<h2><a class="toc-backref" href="#id7">Issues/Bugs</a><a class="headerlink" href="#issues-bugs" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id10">Issues/Bugs</a><a class="headerlink" href="#issues-bugs" title="Permalink to this headline">¶</a></h2>
 <p>Patches, bug reports, and feature requests are all welcome through the <a class="reference external" href="https://github.com/ElasticHQ/elasticsearch-HQ/">GitHub site</a>. Contributions in the form of patches or pull requests are easier to integrate and will receive priority attention.</p>
 </div>
 </div>