Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.textile #48370

Closed
wants to merge 1 commit into from
Closed

Conversation

nithasha-samad
Copy link

  • Have you signed the contributor license agreement?
  • Have you followed the contributor guidelines?
  • If submitting code, have you built your formula locally prior to submission with gradle check?
  • If submitting code, is your pull request against master? Unless there is a good reason otherwise, we prefer pull requests against master and will backport as needed.
  • If submitting code, have you checked that your submission is for an OS and architecture that we support?
  • If you are submitting this code for a class then read our policy for that.

@pgomulka pgomulka added the >docs General docs changes label Oct 23, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@jrodewig jrodewig added the :Delivery/Build Build or test infrastructure label Oct 23, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (:Core/Infra/Build)

@@ -207,7 +207,7 @@ In order to create a distribution, simply run the @./gradlew assemble@ command i

The distribution for each project will be created under the @build/distributions@ directory in that project.

See the "TESTING":TESTING.asciidoc file for more information about running the Elasticsearch test suite.
See "TESTING": TESTING.asciidoc file for more information about running the Elasticsearch test suite.
Copy link
Contributor

@jrodewig jrodewig Oct 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this sentence reads more clearly with the.

Suggested change
See "TESTING": TESTING.asciidoc file for more information about running the Elasticsearch test suite.
See the "TESTING": TESTING.asciidoc file for more information about running the Elasticsearch test suite.


In order to play with the distributed nature of Elasticsearch, simply bring more nodes up and shut down nodes. The system will continue to serve requests (make sure you use the correct http port) with the latest data indexed.
In order to play with the distributed nature of Elasticsearch, simply bring more nodes up and shut down nodes. The system will continue to serve requests (make sure you use the correct Http port) with the latest data indexed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't believe the capitalization is needed here.

Suggested change
In order to play with the distributed nature of Elasticsearch, simply bring more nodes up and shut down nodes. The system will continue to serve requests (make sure you use the correct Http port) with the latest data indexed.
In order to play with the distributed nature of Elasticsearch, simply bring more nodes up and shut down nodes. The system will continue to serve requests (make sure you use the correct http port) with the latest data indexed.

@@ -185,15 +185,15 @@ curl -XGET 'http://localhost:9200/_search?pretty=true' -H 'Content-Type: applica
}'
</pre>

{One liner teaser}: And the cool part about that? You can easily search on multiple twitter users (indices), with different boost levels per user (index), making social search so much simpler (results from my friends rank higher than results from friends of my friends).
{One liner teaser}: And the cool part about that? You can easily search on multiple twitter users (indices), with different boost levels per user (index), making the social search so much simpler (results from my friends rank higher than results from friends of my friends).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reads better without the here.

Suggested change
{One liner teaser}: And the cool part about that? You can easily search on multiple twitter users (indices), with different boost levels per user (index), making the social search so much simpler (results from my friends rank higher than results from friends of my friends).
{One liner teaser}: And the cool part about that? You can easily search on multiple twitter users (indices), with different boost levels per user (index), making social search so much simpler (results from my friends rank higher than results from friends of my friends).


Another way to define our simple twitter system is to have a different index per user (note, though that each index has an overhead). Here is the indexing curl's in this case:
Another way to define our simple twitter system is to have a different index per user (note, though that each index has an overhead). Here is the indexing curl in this case:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are multiple curl requests here.

Suggested change
Another way to define our simple twitter system is to have a different index per user (note, though that each index has an overhead). Here is the indexing curl in this case:
Another way to define our simple twitter system is to have a different index per user (note, though that each index has an overhead). Here is the indexing curl's in this case:

@@ -122,18 +122,18 @@ curl -XGET 'http://localhost:9200/twitter/_search?pretty=true' -H 'Content-Type:
}'
</pre>

There are many more options to perform search, after all, it's a search product no? All the familiar Lucene queries are available through the JSON query language, or through the query parser.
There are many more options to perform the search, after all, it's a search product no? All the familiar Lucene queries are available through the JSON query language, or through the query parser.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the is unneeded.

Suggested change
There are many more options to perform the search, after all, it's a search product no? All the familiar Lucene queries are available through the JSON query language, or through the query parser.
There are many more options to perform search, after all, it's a search product no? All the familiar Lucene queries are available through the JSON query language, or through the query parser.

@@ -109,7 +109,7 @@ curl -XGET 'http://localhost:9200/twitter/_search?pretty=true' -H 'Content-Type:
}'
</pre>

We can also do range search (the @post_date@ was automatically identified as date)
We can also do range search (the @post_date@ was automatically identified as to date)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We can also do range search (the @post_date@ was automatically identified as to date)
We can also do range search (the @post_date@ was automatically identified as a date)

@@ -39,7 +39,7 @@ You need to have a recent version of Java installed. See the "Setup":http://www.
h3. Installation

* "Download":https://www.elastic.co/downloads/elasticsearch and unzip the Elasticsearch official distribution.
* Run @bin/elasticsearch@ on unix, or @bin\elasticsearch.bat@ on windows.
* Run @bin/elasticsearch@ on Unix, or @bin\elasticsearch.bat@ on windows.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Run @bin/elasticsearch@ on Unix, or @bin\elasticsearch.bat@ on windows.
* Run @bin/elasticsearch@ on Unix, or @bin\elasticsearch.bat@ on Windows.

* Built on top of Lucene
** Each shard is a fully functional Lucene index
** All the power of Lucene easily exposed through simple configuration / plugins.
** All the power of Lucene easily exposed through simple configuration/plugins.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
** All the power of Lucene easily exposed through simple configuration/plugins.
** All the power of Lucene easily exposed through simple configuration and plugins.

@@ -21,10 +21,10 @@ Elasticsearch is a distributed RESTful search engine built for the cloud. Featur
** No need for upfront schema definition.
** Schema can be defined for customization of the indexing process.
* Reliable, Asynchronous Write Behind for long term persistency.
* (Near) Real Time Search.
* (Near) Real-Time Search.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* (Near) Real-Time Search.
* (Near) real-time search.

@@ -10,7 +10,7 @@ Elasticsearch is a distributed RESTful search engine built for the cloud. Featur
** Each index is fully sharded with a configurable number of shards.
** Each shard can have one or more replicas.
** Read / Search operations performed on any of the replica shards.
* Multi Tenant.
* Multi-Tenant.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Multi-Tenant.
* Multi-tenant.

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @nithasha-samad. Two things:

  1. I left a few comments and suggestions for you to address.

  2. Could you sign our contributor license agreement? This is necessary before we'll be able to merge your changes.

After you address the feedback and sign the CLA, I can help merge these changes. Thanks again for your contribution.

@jrodewig
Copy link
Contributor

Closing as the CLA is not signed and feedback has not been addressed.

@jrodewig jrodewig closed this Dec 10, 2019
@mark-vieira mark-vieira added the Team:Delivery Meta label for Delivery team label Nov 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Awaiting CLA :Delivery/Build Build or test infrastructure >docs General docs changes feedback_needed Team:Delivery Meta label for Delivery team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants