Skip to content

[DOCS] Adds curl explanation to getting started content #51963

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

Merged
merged 3 commits into from
Feb 6, 2020

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Feb 5, 2020

Related to #29698, which mentioned confusion about which nodes to run an API against.

This PR adds content from https://www.elastic.co/guide/en/elasticsearch/guide/2.x/_talking_to_elasticsearch.html#_restful_api_with_json_over_http to the "Getting started with Elasticsearch" content (https://www.elastic.co/guide/en/elasticsearch/reference/master/getting-started.html), since we don't seem to cover that material anywhere else.

Preview:
http://elasticsearch_51963.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/getting-started-install.html#gs-curl

@lcawl lcawl added >docs General docs changes :Docs v8.0.0 v7.7.0 labels Feb 5, 2020
@lcawl lcawl requested review from debadair and jrodewig February 5, 2020 20:22
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (:Docs)

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.

LGTM. Thanks again @lcawl.

[source,js]
--------------------------------------------------
curl -X<VERB> '<PROTOCOL>://<HOST>:<PORT>/<PATH>?<QUERY_STRING>' -d '<BODY>'
--------------------------------------------------
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this needs // NOTCONSOLE to pass the CI checks.

Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

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

Thanks for doing this! Is it worth calling out in the section that talks about submitting REST requests that they can target any node in the cluster? That's true whether or not you use cURL.

@lcawl
Copy link
Contributor Author

lcawl commented Feb 6, 2020

Is it worth calling out in the section that talks about submitting REST requests that they can target any node in the cluster?

Do you mean step 5 in this page or somewhere else in the book? I'll go ahead and merge this PR but am happy to add more clarifications elsewhere hereafter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants