Written guide for elasticsearch local #3881

irkartik · 2018-03-30T05:41:12Z

With reference to #3803 and in replacement of #3852 .

I have created a new PR because of following reasons:

I had pushed the changes to master branch previously.
In order to sync the master branch of forked repo to the RTD repo, I had git pushed hard (i know that is not a good practice but that was the only way I could think of). This automatically closed the previous PR.
Unintentional files edited by other users were reflected to the previous PR (i've no idea how)

berkerpeksag · 2018-04-16T12:03:13Z

docs/guides/run-elasticsearch-local.rst

+
+	$ ps -p 1	
+
+**Running Elasticsearch with SysV init**


I'd leave how to run Elasticsearch to users for several reasons:

There are multiple init systems and it would be nice to not maintain these commands in our documentation.

People may want to add their choice of init system to the documentation and that would also increase the maintenance work.

They also can use it without using any init systems and package managers:

$ wget https://download.elastic.co/elasticsearch/elasticsearch/elasticsearch-1.3.8.tar.gz $ tar xf elasticsearch-1.3.8.tar.gz $ cd elasticsearch-1.3.8/ $ ./bin/elasticsearch

I wonder if we should document this method instead since it makes installing and running Elasticsearch without having to deal with different init systems, package managers, and distros.

First I thought of writing exactly the same as mentioned by you (i.e directly downloading the tar file), it was previously covered in #3852 . As the said method has an advantage of not having to maintain the init systems, we have a disadvantage of having to start the elasticsearch server each time we need to run our RTD server locally.

berkerpeksag · 2018-04-16T12:06:52Z

docs/guides/run-elasticsearch-local.rst

+4. Index the data available at RTD database
+-------------------------------------------
+
+In order to search through the RTD database, you need to index it into the elasticsearch index.:: 


[...] index.::

will be converted to HTML as

[...] index.:

I'd drop the "." character.

berkerpeksag · 2018-04-16T12:07:24Z

docs/guides/run-elasticsearch-local.rst

+
+After installing java, verify the installation by,::
+
+	$ java -version


Style nit: Please don't use tab characters.

do you mean $ sign?

Sorry, I wasn't clear in my earlier comment. I meant don't use the \t character to indent code. See the following comparison:

# With using tab: $ java -version # Without tabs, used four spaces instead: $ java -version

changed as mentioned 👍

berkerpeksag · 2018-04-16T12:08:18Z

docs/guides/run-elasticsearch-local.rst

+1. Installing Java
+------------------
+
+Elasticsearch requires JAVA 8 or later. Use `Oracle official documentation <http://www.oracle.com/technetwork/java/javase/downloads/index.html>`_. 


Style nit: I don't know which one is correct (Java vs. JAVA) but please use the same style in the documentation.

berkerpeksag · 2018-04-16T12:11:01Z

docs/guides/run-elasticsearch-local.rst

+Enabling Elasticsearch on the local server
+==========================================
+
+Read the Docs has been using Elasticsearch which is a platform for distributed search and analysis of data in real time. To enable the search feature on your local installation, you need to install the elasticsearch locally and run the Elastic server. 


Style nit: Please wrap lines at 80 characters.

@rajujha373 @berkerpeksag actually, rtd doesn't use that style of wrapping all lines to 80 characters, here are the guidelines for writing docs https://docs.readthedocs.io/en/latest/docs.html#content. Note that this was recently added.

berkerpeksag · 2018-04-16T12:11:25Z

docs/guides/run-elasticsearch-local.rst

+Enabling Elasticsearch on the local server
+==========================================
+
+Read the Docs has been using Elasticsearch which is a platform for distributed search and analysis of data in real time. To enable the search feature on your local installation, you need to install the elasticsearch locally and run the Elastic server. 


"the elasticsearch" -> can "the" be dropped here?

berkerpeksag · 2018-04-16T12:12:27Z

docs/guides/run-elasticsearch-local.rst

+2. Downloading and installing Elasticsearch
+-------------------------------------------
+
+Elasticsearch can be downloaded directly from elastic.co in zip, tar.gz, deb, or rpm packages. For Ubuntu, it's best to use the deb (Debian) package which will install everything you need to run Elasticsearch.


I'd drop the "in zip, tar.gz, deb, or rpm packages" part to make it brief.

berkerpeksag · 2018-04-16T12:13:20Z

docs/guides/run-elasticsearch-local.rst

+Elasticsearch can be downloaded directly from elastic.co in zip, tar.gz, deb, or rpm packages. For Ubuntu, it's best to use the deb (Debian) package which will install everything you need to run Elasticsearch.
+
+RTD currently uses elasticsearch 1.x which can be easily downloaded and installed from the `Official Website 
+<https://www.elastic.co/downloads/>`_.


from the Official Website -> from elastic.co

berkerpeksag · 2018-04-16T12:14:44Z

docs/guides/run-elasticsearch-local.rst

+RTD currently uses elasticsearch 1.x which can be easily downloaded and installed from the `Official Website 
+<https://www.elastic.co/downloads/>`_.
+
+	1. First download the deb package version 1.3.8 from this `Link <https://www.elastic.co/downloads/past-releases/elasticsearch-1-3-8>`_.


I'd merge the first item with the paragraph above. Since we need to install a specific version of Elasticsearch, we don't need to mention the generic downloads page. We can just link to the download page of 1.3.8.

berkerpeksag · 2018-04-16T12:23:54Z

docs/guides/run-elasticsearch-local.rst

+	1. First download the deb package version 1.3.8 from this `Link <https://www.elastic.co/downloads/past-releases/elasticsearch-1-3-8>`_.
+
+	2. Install the downloaded package by following command 
+		``$ sudo apt install .{path-to-downloaded-file}/elasticsearch-1.3.8.deb``


We can use a code block instead of ``...``:

2. [...] command:: $ sudo apt install .{path-to-downloaded-file}/elasticsearch-1.3.8.deb

berkerpeksag · 2018-04-16T12:33:09Z

Oh, I forgot to mention that this new document should be linked in http://docs.readthedocs.io/en/latest/install.html (see the fourth note)

irkartik · 2018-04-16T13:06:49Z

that sounds really motivating @berkerpeksag thank you :)

irkartik · 2018-04-22T05:28:43Z

Hi @berkerpeksag is there anything more to be done in this PR?

berkerpeksag · 2018-04-23T00:01:17Z

@rajujha373 did you address all reviews comments or am I seeing an outdated version of your PR for some reason? For example, the new document didn't linked in install.rst and @stsewd comment in #3881 (comment) didn't seem to be addressed.

stsewd · 2018-04-23T16:18:28Z

docs/guides/run-elasticsearch-local.rst

@@ -1,3 +1,5 @@
+.. _running-elasticsearch-locally:


There is no need to add this if you use the doc role :)

Oh yes, I was checking out how to link the files ... Forgot to delete it .. 😀

safwanrahman · 2018-06-03T18:33:32Z

Hi @rajujha373, Thanks for the writeup.
Can you please add instruction about installing the elasticsearch-analysis-icu plugin and creating the indexes?
You can see the example here

ericholscher · 2018-06-06T20:37:07Z

This is a good change. I'm going to merge it to get the data published, and it can be improved over time.

Build on top of #3881 and put docs in custom_installs.

written guide for elasticsearch local

f31d441

RichardLitt added the PR: ready for review label Mar 30, 2018

This was referenced Apr 16, 2018

Search working in documents but not in the project Home. #2174

Closed

Search engine setup #1673

Closed

berkerpeksag suggested changes Apr 16, 2018

View reviewed changes

done requested changes and resolved styling issues

b448a88

irkartik added 3 commits April 16, 2018 18:39

typo correction

9363600

grammar correction

4adc8a6

converted indentation to spaces

3c73c7c

added link from install.rst to run-elasticsearch-local.rst

ec37b68

stsewd reviewed Apr 23, 2018

View reviewed changes

removed unwanted line

a5c86fe

stsewd mentioned this pull request May 23, 2018

Centos7_python2.7.5 virtualenv Import project error #4122

Closed

ericholscher mentioned this pull request Jun 6, 2018

Build on top of #3881 and put docs in custom_installs. #4196

Merged

ericholscher merged commit a5c86fe into readthedocs:master Jun 7, 2018

ericholscher added a commit that referenced this pull request Jun 7, 2018

Merge pull request #4196 from rtfd/rajujha373-elasticsearch-guide

ffd54ab

Build on top of #3881 and put docs in custom_installs.

stsewd mentioned this pull request Jun 14, 2018

Elasticsearch not working in local installation #3803

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Written guide for elasticsearch local #3881

Written guide for elasticsearch local #3881

irkartik commented Mar 30, 2018

berkerpeksag Apr 16, 2018

irkartik Apr 16, 2018

berkerpeksag Apr 16, 2018

berkerpeksag Apr 16, 2018

irkartik Apr 16, 2018

berkerpeksag Apr 16, 2018

irkartik Apr 16, 2018

berkerpeksag Apr 16, 2018

berkerpeksag Apr 16, 2018

stsewd Apr 16, 2018

berkerpeksag Apr 16, 2018

berkerpeksag Apr 16, 2018

berkerpeksag Apr 16, 2018

berkerpeksag Apr 16, 2018

berkerpeksag Apr 16, 2018

berkerpeksag commented Apr 16, 2018

irkartik commented Apr 16, 2018

irkartik commented Apr 22, 2018

berkerpeksag commented Apr 23, 2018

stsewd Apr 23, 2018

irkartik Apr 23, 2018

safwanrahman commented Jun 3, 2018

ericholscher commented Jun 6, 2018


		After installing java, verify the installation by,::

		$ java -version

Written guide for elasticsearch local #3881

Written guide for elasticsearch local #3881

Conversation

irkartik commented Mar 30, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

berkerpeksag commented Apr 16, 2018

irkartik commented Apr 16, 2018

irkartik commented Apr 22, 2018

berkerpeksag commented Apr 23, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

safwanrahman commented Jun 3, 2018

ericholscher commented Jun 6, 2018