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

[DOCS] Refactor quick start guide and README #71331

Merged
merged 27 commits into from
Apr 20, 2021
Merged
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
b44c8ef
[DOCS] Refactor quick start guide and README
jrodewig Apr 2, 2021
c7f77d0
Add tip for skip step
jrodewig Apr 6, 2021
1c429a8
Consistent whitespace
jrodewig Apr 6, 2021
c5f0a98
Fix minor typo
jrodewig Apr 7, 2021
e6730c4
Improve examples by narrowing search results
jrodewig Apr 7, 2021
c1e6d89
Minor edits
jrodewig Apr 8, 2021
8af171c
Merge remote-tracking branch 'upstream/master' into docs__refactor-qu…
jrodewig Apr 8, 2021
7fb0687
Apply suggestions from code review
jrodewig Apr 9, 2021
f707e16
Adjust README for review feedback
jrodewig Apr 9, 2021
5a648c6
Remove TOC from README
jrodewig Apr 9, 2021
c8c8e5d
Expand {es}
jrodewig Apr 9, 2021
0e3bdd4
Consistent wording
jrodewig Apr 9, 2021
2ea2f1b
Address review feedback
jrodewig Apr 9, 2021
eea8c1f
Improve API call examples
jrodewig Apr 9, 2021
2ab570e
Forgot to commit this
jrodewig Apr 9, 2021
3c8f5af
Remove test var
jrodewig Apr 9, 2021
68b0115
Reword
jrodewig Apr 9, 2021
69b63c5
Remove unneeded sentence
jrodewig Apr 9, 2021
1b1c8a0
Avoid cluster. Use deployment/instance
jrodewig Apr 9, 2021
40879c2
Remove unneeded sentence
jrodewig Apr 10, 2021
1e0cea5
Merge branch 'master' into docs__refactor-quick-start
elasticmachine Apr 10, 2021
0d6b45a
Reword
jrodewig Apr 10, 2021
dd36236
Fix typo
jrodewig Apr 11, 2021
39b6ef5
Merge remote-tracking branch 'upstream/master' into docs__refactor-qu…
jrodewig Apr 19, 2021
d9cf659
Add agg example
jrodewig Apr 19, 2021
de3284d
Reword
jrodewig Apr 19, 2021
edf6090
Apply review suggestions
jrodewig Apr 20, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Avoid cluster. Use deployment/instance
  • Loading branch information
jrodewig committed Apr 9, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 1b1c8a09c212c8331208b7c4cc8904142d44585c
13 changes: 7 additions & 6 deletions docs/reference/tab-widgets/api-call.asciidoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
// tag::cloud[]
**Use curl**

. To communicate with {es} using curl or another client, you need your cluster's
endpoint. Go to the **Elasticsearch** page and click **Copy endpoint**.
. To communicate with {es} using curl or another client, you need your
deployment's endpoint. Go to the **Elasticsearch** page and click **Copy
endpoint**.

. To submit an example API request, run the following curl command in a new
terminal session. Replace `<password>` with the password for the `elastic` user.
Replace `<elasticsearch_endpoint>` with your cluster's endpoint.
Replace `<elasticsearch_endpoint>` with your endpoint.
+
[source,sh]
----
curl -u elastic:<password> <elasticsearch_endpoint>/
----
// NOTCONSOLE
+
The API returns information about your {es} cluster.
The API returns information about your {es} instance.

**Use {kib}**

@@ -33,7 +34,7 @@ image::images/kibana-console.png[{kib} Console,align="center"]
GET /
----
+
The API returns information about your {es} cluster.
The API returns information about your {es} instance.

//end::kibana-api-ex[]
// end::cloud[]
@@ -50,7 +51,7 @@ curl -X GET http://localhost:9200/
----
// NOTCONSOLE

The API returns information about your {es} cluster.
The API returns information about your {es} instance.

**Use {kib}**