Merge pull request #315 from untergeek/doc_updates

Doc updates

.gitignore

@@ -14,3 +14,4 @@ elasticsearch_curator_dev.egg-info
 coverage.xml
 nosetests.xml
 index.html
+docs/asciidoc/html_docs

CONTRIBUTING.md

@@ -10,13 +10,25 @@ That said, some basic guidelines, which you are free to ignore :)
 
 ## Want to learn?
 
-Want to lurk about and see what others are doing with Curator? 
+Want to write your own code to do something Curator doesn't do out of the box?
+
+* [Curator API Documentation](http://curator.readthedocs.org/) Since version 2.0,
+Curator ships with both an API and wrapper scripts (which are actually defined
+as entry points).  This allows you to write your own scripts to accomplish
+similar goals, or even new and different things with the [Curator API](http://curator.readthedocs.org/), and the
+[Elasticsearch Python API](http://elasticsearch-py.readthedocs.org/).
+
+Want to know how to use the command-line interface (CLI)?
+
+* [Curator CLI Documentation](http://www.elastic.co/guide/en/elasticsearch/client/curator/current/index.html) The Curator CLI Documentation is now a part of the document repository at http://elastic.co/guide at http://www.elastic.co/guide/en/elasticsearch/client/curator/current/index.html
+
+Want to lurk about and see what others are doing with Curator?
 
 * The irc channels (#logstash and #elasticsearch on irc.freenode.org) are good places for this
 
 ## Got Questions?
 
-Have a problem you want Curator to solve for you? 
+Have a problem you want Curator to solve for you?
 
 * You are welcome to join the IRC channel #logstash (or #elasticsearch) on
 irc.freenode.org and ask for help there!
@@ -35,16 +47,24 @@ If you think you found a bug, it probably is a bug.
 
 If you have a bugfix or new feature that you would like to contribute to
 Curator, and you think it will take more than a few minutes to produce the fix
-(ie; write code), it is worth discussing the change with the Curator users and 
-developers first! You can reach us via [github](https://github.com/elastic/logstash/issues), 
+(ie; write code), it is worth discussing the change with the Curator users and
+developers first! You can reach us via [github](https://github.com/elastic/logstash/issues),
 or via IRC (#logstash or #elasticsearch on freenode irc)
 
+Documentation is in two parts: API and CLI documentation.
+
+API documentation is generated from comments inside the classes and methods within
+the code.  This documentation is rendered and hosted at http://curator.readthedocs.org
+
+CLI documentation is in Asciidoc format in the GitHub repository at https://github.com/elastic/curator/tree/master/docs/asciidoc.
+This documentation can be changed via a pull request as with any other code change.
+
 ## Contribution Steps
 
-1. Test your changes! Run the test suite ('python setup.py test').  Please note 
-   that this requires an Elasticsearch instance. The tests will try to connect 
-   to your local elasticsearch instance and run integration tests against it. 
-   **This will delete all the data stored there!** You can use the env variable 
+1. Test your changes! Run the test suite ('python setup.py test').  Please note
+   that this requires an Elasticsearch instance. The tests will try to connect
+   to your local elasticsearch instance and run integration tests against it.
+   **This will delete all the data stored there!** You can use the env variable
    `TEST_ES_SERVER` to point to a different instance (for example 'otherhost:9203').
 2. Please make sure you have signed our [Contributor License
    Agreement](http://www.elastic.co/contributor-agreement/). We are not
@@ -57,5 +77,3 @@ or via IRC (#logstash or #elasticsearch on freenode irc)
    request](https://help.github.com/articles/using-pull-requests). In the pull
    request, describe what your changes do and mention any bugs/issues related
    to the pull request.
-
-

LICENSE.txt

@@ -1,13 +1,13 @@
-   Copyright 2011–2015 Elasticsearch <http://www.elasticsearch.org> and contributors.
+Copyright 2011–2015 Elastic <http://elastic.co> and contributors.
 
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-       http://www.apache.org/licenses/LICENSE-2.0
+   http://www.apache.org/licenses/LICENSE-2.0
 
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -5,31 +5,34 @@ Have indices in Elasticsearch? This is the tool for you!
 Like a museum curator manages the exhibits and collections on display,
 Elasticsearch Curator helps you curate, or manage your indices.
 
-## [Curator API Documentation](http://curator.readthedocs.org/) (External)
+## [Curator API Documentation](http://curator.readthedocs.org/)
 
-Since Curator 3.0, curator ships with both an API and wrapper scripts (which are
+Since version 2.0, Curator ships with both an API and wrapper scripts (which are
 actually defined as entry points).  This allows you to write your own scripts to
-accomplish similar goals, or even new and different things with the [Curator API](http://curator.readthedocs.org/), and the [Elasticsearch Python API](http://elasticsearch-py.readthedocs.org/).
+accomplish similar goals, or even new and different things with the [Curator API](http://curator.readthedocs.org/),
+and the [Elasticsearch Python API](http://elasticsearch-py.readthedocs.org/).
 
-## [Curator CLI Documentation (GitHub wiki)](http://github.com/elastic/curator/wiki)
+## [Curator CLI Documentation](http://www.elastic.co/guide/en/elasticsearch/client/curator/current/index.html)
 
-See the [Documentation Wiki](http://github.com/elastic/curator/wiki)!
-Try the new asciidoc [documentation for the CLI](https://github.com/elastic/curator/blob/master/docs/asciidoc/index.asciidoc).
+The Curator CLI Documentation is now a part of the document repository at
+http://elastic.co/guide at http://www.elastic.co/guide/en/elasticsearch/client/curator/current/index.html
 
-## Usage
+
+## Getting Started
 
 Install using pip
 
     pip install elasticsearch-curator
 
-See `curator --help` for usage specifics.
+Run `curator --help` for usage specifics.
 
-## [Documentation & Examples](http://github.com/elastic/curator/wiki)
+## [Documentation & Examples](http://www.elastic.co/guide/en/elasticsearch/client/curator/current/index.html)
 
-Try the new asciidoc [documentation for the CLI](https://github.com/elastic/curator/blob/master/docs/asciidoc/index.asciidoc).
-See the [Curator Wiki](http://github.com/elastic/curator/wiki) on Github
-for more documentation
+The documentation for the CLI is now part of the document repository at http://elastic.co/guide
+at http://www.elastic.co/guide/en/elasticsearch/client/curator/current/index.html
 
+The [Curator Wiki](http://github.com/elastic/curator/wiki) on Github is now a
+place to add your own examples and ideas.
 
 ## Contributing
 
@@ -43,7 +46,7 @@ for more documentation
 To run from source, use the `run_curator.py` and `run_es_repo_mgr.py` scripts
 in the root directory of the project.
 
-### Running tests
+### Running Tests
 
 To run the test suite just run `python setup.py test`
 

docs/asciidoc/commands/index.asciidoc

@@ -4,16 +4,16 @@
 [partintro]
 --
 
-* <<alias>>
-* <<allocation>>
-* <<bloom>>
-* <<close>>
-* <<delete>>
-* <<open>>
-* <<optimize>>
-* <<replicas>>
-* <<show>>
-* <<snapshot>>
+* <<alias,alias>>
+* <<allocation,allocation>>
+* <<bloom,bloom>>
+* <<close,close>>
+* <<delete,delete>>
+* <<open,open>>
+* <<optimize,optimize>>
+* <<replicas,replicas>>
+* <<show,show>>
+* <<snapshot,snapshot>>
 --
 
 include::alias.asciidoc[]

docs/asciidoc/index.asciidoc

@@ -1,10 +1,10 @@
-[[curator-reference]]
-= Curator Reference
-
 :curator_version: 3.0.2
 :ref:  http://www.elastic.co/guide/en/elasticsearch/reference/current
 
+[[curator-reference]]
+= Curator Reference
 
+include::misc/about.asciidoc[]
 include::misc/getting_started.asciidoc[]
 include::flags/index.asciidoc[]
 include::commands/index.asciidoc[]

docs/asciidoc/misc/about.asciidoc

@@ -0,0 +1,105 @@
+[[about]]
+= About
+
+[partintro]
+--
+
+Like a museum curator manages the exhibits and collections on display,
+Elasticsearch Curator helps you curate, or manage your Elasticsearch indices.
+--
+
+== Origin
+
+Curator was first called
+https://logstash.jira.com/browse/LOGSTASH-211[`clearESindices.py`].  Its sole
+function was to delete indices. It was almost immediately renamed to
+https://logstash.jira.com/browse/LOGSTASH-211[`logstash_index_cleaner.py`].
+After a time it was briefly relocated under the
+https://github.com/elastic/logstash[logstash] repository as
+`expire_logs`, at which point it began to gain new functionality.  Soon
+thereafter, Jordan Sissel was hired by Elastic (then still Elasticsearch), as
+was the original author of Curator.  Not long after that it became Elasticsearch
+Curator and is now hosted at https://github.com/elastic/curator
+
+Curator now performs many operations on your Elasticsearch indices, from delete
+to snapshot to shard allocation routing.
+
+== Features
+
+Curator allows for many different operations to be performed to both indices and
+snapshots, including:
+
+* Add or remove indices from an <<alias,alias>>
+* Shard routing <<allocation,allocation>>
+* Disabling <<bloom,Bloom>> filter caches (for versions of Elasticsearch < 1.4)
+* <<close,Close>> indices
+* <<delete,Delete>> indices and snapshots
+* <<open,Open>> closed indices
+* <<optimize,Optimize>> indices
+* Change the number of <<replicas,replicas>> per shard for indices
+* <<show,Show>> indices and snapshots
+* Take a <<snapshot,snapshot>> (backup) of indices.
+
+[[about-cli]]
+== Command-Line Interface (CLI)
+
+Curator has always been a command-line tool. When Curator 2.0 was released, it
+was the first attempt to separate the <<about-api,API>> from the CLI.
+
+This site provides the documentation for how to use Curator on the command-line.
+
+TIP: Learn more about <<command-line,the command-line interface>>.
+
+[[about-api]]
+== Application Program Interface (API)
+
+Since version 2.0, Curator ships with both an API and wrapper scripts (which are
+actually defined as entry points).  The API, or Application Program Interface,
+allows you to write your own scripts to accomplish similar goals--or even new
+and different things--with the same code that Curator uses.
+
+The API documentation is not on this site, but is available at
+http://curator.readthedocs.org/.  The Curator API is built using
+the
+http://www.elastic.co/guide/en/elasticsearch/client/python-api/current/index.html[Elasticsearch
+Python API].
+
+[[license]]
+== License
+
+Copyright 2011–2015 Elastic <http://elastic.co> and contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+[[site-corrections]]
+== Site Corrections
+
+All documentation on this site allows for quick correction submission.
+
+To do this, use the "Edit" link to the right on any page.
+
+* You will need to log in with your GitHub account.
+* Make your corrections or additions to the documentation.
+* Please use the option to "Create a new branch for this commit and start a pull
+request."
+* Please make sure you have signed our
+http://www.elastic.co/contributor-agreement/[Contributor License Agreement]. We
+are not asking you to assign copyright to us, but to give us the right to
+distribute your code (even documentation corrections) without restriction. We
+ask this of all contributors in order to assure our users of the origin and
+continuing existence of the code. You only need to sign the CLA once. If you are
+uncomfortable with this, feel free to submit a
+https://github.com/elastic/curator/issues[GitHub Issue] with your suggested
+correction instead.
+* Changes will be reviewed and merged, if acceptable.

docs/asciidoc/misc/contributing.asciidoc

@@ -25,3 +25,6 @@ A brief overview of the steps
 * run tests
 * sign the http://elastic.co/contributor-agreement/[CLA]
 * send a pull request!
+
+TIP: To submit documentation fixes for this site, see
+<<site-corrections,Site Corrections>>

docs/asciidoc/misc/faq.asciidoc

@@ -6,6 +6,14 @@
 This section will be updated as more frequently asked questions arise
 --
 
+== Q: How can I report an error in the documentation?
+
+[float]
+A: Use the "Edit" link on any page
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+See <<site-corrections,Site Corrections>>.
+
 == Q: Can I delete only certain data from within indices?
 
 [float]