Adds Dev Tools Console documentation #1576

kolchfa-aws · 2022-10-14T21:01:31Z

Fixes #1401

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Fanit Kolchina <[email protected]>

alicejw1 · 2022-10-14T21:40:24Z

_dashboards/run-queries.md

+nav_order: 110
+---
+
+# Running queries in Console


"the Console"

alicejw1 · 2022-10-14T21:40:43Z

_dashboards/run-queries.md

+
+You can use the OpenSearch DevTools Console to send queries to OpenSearch. 
+
+## Navigating to Console


use "the Console" throughout, unless you identify it by the full name: OpenSearch DevTools Console.

alicejw1 · 2022-10-14T21:42:13Z

_dashboards/run-queries.md

+
+## Navigating to Console
+
+To open Console, select **Dev Tools** on the main OpenSearch Dashboards page:


Suggested change

To open Console, select **Dev Tools** on the main OpenSearch Dashboards page:

To open Console, select **Dev Tools** in the OpenSearch Dashboards:

alicejw1 · 2022-10-14T21:44:06Z

_dashboards/run-queries.md

+
+<img src="{{site.url}}{{site.baseurl}}/images/dev-tools/dev-tools-main.png" alt="Dev Tools Console from main page">{: .img-fluid }
+
+You can open Console from any other page by navigating to the main menu and selecting **Management** > **Dev Tools**.


Suggested change

You can open Console from any other page by navigating to the main menu and selecting **Management** > **Dev Tools**.

You can open Console from any other pane by navigating to the main menu and selecting **Management** > **Dev Tools**.

_dashboards/run-queries.md

alicejw1 · 2022-10-14T21:49:13Z

_dashboards/run-queries.md

+
+## Sending the request 
+
+To send a query to OpenSearch, select the query by placing the cursor anywhere in the query text. Then choose the triangle on the top right of the request or press `Ctrl/Cmd+Enter`:


Suggested change

To send a query to OpenSearch, select the query by placing the cursor anywhere in the query text. Then choose the triangle on the top right of the request or press `Ctrl/Cmd+Enter`:

To send the request to OpenSearch, select the query by placing the cursor anywhere within the editor. Select the triangle, or press `Ctrl/Cmd+Enter`:

alicejw1 · 2022-10-14T21:50:07Z

_dashboards/run-queries.md

+
+## Working in cURL and Console formats
+
+Console uses an easier syntax to format REST requests than the `curl` command. 


The Console

alicejw1 · 2022-10-14T21:50:54Z

_dashboards/run-queries.md

+}
+```
+
+If you paste a `curl` command directly into the Console, the command is automatically converted into Console format. 


Suggested change

If you paste a `curl` command directly into the Console, the command is automatically converted into Console format.

If you paste a `curl` command directly into the Console, the command is automatically converted into JSON format.

alicejw1

Looks good!
I made some minor suggestions.

ariamarble

LGTM with suggestions

Co-authored-by: Alice Williams <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>

…ject/documentation-website into Fix1401-dev-tools

_dashboards/run-queries.md

lizsnyder · 2022-10-17T17:47:23Z

_dashboards/run-queries.md

+
+## Navigating to the console
+
+To open the console, select **Dev Tools** on the main OpenSearch Dashboards page:


"in the left navigation pane" perhaps? Unless your team has a defined way of referring to it already.

Signed-off-by: Fanit Kolchina <[email protected]>

lizsnyder · 2022-10-17T18:02:51Z

Thanks so much @kolchfa-aws! Excited that I'll finally have a place to link off to from my docs when I refer to the dev console.

natebower

@kolchfa-aws Just a few comments and changes. Thanks!

_dashboards/run-queries.md

natebower · 2022-10-20T16:29:01Z

_dashboards/run-queries.md

+
+## Viewing documentation
+
+To view OpenSearch documentation, select the wrench icon, and choose **Open documentation**.


"the OpenSearch documentation"?

_dashboards/run-queries.md

Co-authored-by: Nate Bower <[email protected]>

Incorporated editorial comments.

* Adds Dev Tools Console documentation Signed-off-by: Fanit Kolchina <[email protected]> * Images for console Signed-off-by: Fanit Kolchina <[email protected]> * Separate directory for dev tools images Signed-off-by: Fanit Kolchina <[email protected]> * Update _dashboards/run-queries.md Co-authored-by: Alice Williams <[email protected]> * Update _dashboards/run-queries.md Co-authored-by: Alice Williams <[email protected]> * Implemented doc review feedback Signed-off-by: Fanit Kolchina <[email protected]> * Formatting dev tools Signed-off-by: Fanit Kolchina <[email protected]> * Update _dashboards/run-queries.md Co-authored-by: Nate Bower <[email protected]> * Update _dashboards/run-queries.md Co-authored-by: Nate Bower <[email protected]> * Update _dashboards/run-queries.md Co-authored-by: Nate Bower <[email protected]> * Update _dashboards/run-queries.md Co-authored-by: Nate Bower <[email protected]> * Update run-queries.md Incorporated editorial comments. Signed-off-by: Fanit Kolchina <[email protected]> Co-authored-by: Alice Williams <[email protected]> Co-authored-by: Nate Bower <[email protected]> (cherry picked from commit c1670cd)

* Adds Dev Tools Console documentation Signed-off-by: Fanit Kolchina <[email protected]> * Images for console Signed-off-by: Fanit Kolchina <[email protected]> * Separate directory for dev tools images Signed-off-by: Fanit Kolchina <[email protected]> * Update _dashboards/run-queries.md Co-authored-by: Alice Williams <[email protected]> * Update _dashboards/run-queries.md Co-authored-by: Alice Williams <[email protected]> * Implemented doc review feedback Signed-off-by: Fanit Kolchina <[email protected]> * Formatting dev tools Signed-off-by: Fanit Kolchina <[email protected]> * Update _dashboards/run-queries.md Co-authored-by: Nate Bower <[email protected]> * Update _dashboards/run-queries.md Co-authored-by: Nate Bower <[email protected]> * Update _dashboards/run-queries.md Co-authored-by: Nate Bower <[email protected]> * Update _dashboards/run-queries.md Co-authored-by: Nate Bower <[email protected]> * Update run-queries.md Incorporated editorial comments. Signed-off-by: Fanit Kolchina <[email protected]> Co-authored-by: Alice Williams <[email protected]> Co-authored-by: Nate Bower <[email protected]> (cherry picked from commit c1670cd) Co-authored-by: kolchfa-aws <[email protected]>

Adds Dev Tools Console documentation

0ef6576

Signed-off-by: Fanit Kolchina <[email protected]>

kolchfa-aws added backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 labels Oct 14, 2022

kolchfa-aws self-assigned this Oct 14, 2022

kolchfa-aws requested a review from a team as a code owner October 14, 2022 21:01

kolchfa-aws added 2 commits October 14, 2022 17:02

Images for console

8686ad9

Signed-off-by: Fanit Kolchina <[email protected]>

Separate directory for dev tools images

4d99fe2

Signed-off-by: Fanit Kolchina <[email protected]>

alicejw1 reviewed Oct 14, 2022

View reviewed changes

_dashboards/run-queries.md Outdated

nav_order: 110

---

# Running queries in Console

Copy link

Contributor

alicejw1 Oct 14, 2022

Choose a reason for hiding this comment

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

"the Console"

alicejw1 reviewed Oct 14, 2022

View reviewed changes

_dashboards/run-queries.md Outdated Show resolved Hide resolved

alicejw1 reviewed Oct 14, 2022

View reviewed changes

_dashboards/run-queries.md Outdated Show resolved Hide resolved

alicejw1 reviewed Oct 14, 2022

View reviewed changes

alicejw1 approved these changes Oct 14, 2022

View reviewed changes

ariamarble approved these changes Oct 14, 2022

View reviewed changes

kolchfa-aws and others added 4 commits October 17, 2022 12:46

Update _dashboards/run-queries.md

090d2ae

Co-authored-by: Alice Williams <[email protected]>

Update _dashboards/run-queries.md

acdfa66

Co-authored-by: Alice Williams <[email protected]>

Implemented doc review feedback

152fdaf

Signed-off-by: Fanit Kolchina <[email protected]>

Merge branch 'Fix1401-dev-tools' of https://github.com/opensearch-pro…

a970c56

…ject/documentation-website into Fix1401-dev-tools

lizsnyder reviewed Oct 17, 2022

View reviewed changes

_dashboards/run-queries.md Outdated Show resolved Hide resolved

lizsnyder reviewed Oct 17, 2022

View reviewed changes

Formatting dev tools

5eeef07

Signed-off-by: Fanit Kolchina <[email protected]>

kolchfa-aws added the 5 - Editorial review PR: Editorial review in progress label Oct 17, 2022

natebower reviewed Oct 20, 2022

View reviewed changes

natebower removed the 5 - Editorial review PR: Editorial review in progress label Oct 20, 2022

kolchfa-aws and others added 5 commits October 25, 2022 11:10

Update _dashboards/run-queries.md

fdba234

Co-authored-by: Nate Bower <[email protected]>

Update _dashboards/run-queries.md

d3be52b

Co-authored-by: Nate Bower <[email protected]>

Update _dashboards/run-queries.md

a50fb1b

Co-authored-by: Nate Bower <[email protected]>

Update _dashboards/run-queries.md

21e4409

Co-authored-by: Nate Bower <[email protected]>

Update run-queries.md

78644e0

Incorporated editorial comments.

kolchfa-aws merged commit c1670cd into main Oct 25, 2022

opensearch-trigger-bot bot mentioned this pull request Oct 25, 2022

[Backport 1.3] Adds Dev Tools Console documentation #1663

Merged

This was referenced Oct 25, 2022

[Backport 2.0] Adds Dev Tools Console documentation #1664

Merged

[Backport 2.1] Adds Dev Tools Console documentation #1665

Merged

opensearch-trigger-bot bot mentioned this pull request Oct 25, 2022

[Backport 2.2] Adds Dev Tools Console documentation #1666

Merged

opensearch-trigger-bot bot mentioned this pull request Oct 25, 2022

[Backport 2.3] Adds Dev Tools Console documentation #1667

Merged

Naarcha-AWS deleted the Fix1401-dev-tools branch December 13, 2022 19:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds Dev Tools Console documentation #1576

Adds Dev Tools Console documentation #1576

kolchfa-aws commented Oct 14, 2022 •

edited

Loading

alicejw1 Oct 14, 2022

alicejw1 Oct 14, 2022 •

edited

Loading

alicejw1 Oct 14, 2022

alicejw1 Oct 14, 2022

alicejw1 Oct 14, 2022

alicejw1 Oct 14, 2022

alicejw1 Oct 14, 2022

alicejw1 left a comment

ariamarble left a comment

lizsnyder Oct 17, 2022

lizsnyder commented Oct 17, 2022

natebower left a comment

natebower Oct 20, 2022


		You can use the OpenSearch DevTools Console to send queries to OpenSearch.

		## Navigating to Console


		## Navigating to Console

		To open Console, select Dev Tools on the main OpenSearch Dashboards page:

	To open Console, select Dev Tools on the main OpenSearch Dashboards page:
	To open Console, select Dev Tools in the OpenSearch Dashboards:


		<img src="{{site.url}}{{site.baseurl}}/images/dev-tools/dev-tools-main.png" alt="Dev Tools Console from main page">{: .img-fluid }

		You can open Console from any other page by navigating to the main menu and selecting Management > Dev Tools.

	You can open Console from any other page by navigating to the main menu and selecting Management > Dev Tools.
	You can open Console from any other pane by navigating to the main menu and selecting Management > Dev Tools.


		## Sending the request

		To send a query to OpenSearch, select the query by placing the cursor anywhere in the query text. Then choose the triangle on the top right of the request or press `Ctrl/Cmd+Enter`:

	To send a query to OpenSearch, select the query by placing the cursor anywhere in the query text. Then choose the triangle on the top right of the request or press `Ctrl/Cmd+Enter`:
	To send the request to OpenSearch, select the query by placing the cursor anywhere within the editor. Select the triangle, or press `Ctrl/Cmd+Enter`:


		## Working in cURL and Console formats

		Console uses an easier syntax to format REST requests than the `curl` command.

	If you paste a `curl` command directly into the Console, the command is automatically converted into Console format.
	If you paste a `curl` command directly into the Console, the command is automatically converted into JSON format.


		## Navigating to the console

		To open the console, select Dev Tools on the main OpenSearch Dashboards page:


		## Viewing documentation

		To view OpenSearch documentation, select the wrench icon, and choose Open documentation.

Adds Dev Tools Console documentation #1576

Adds Dev Tools Console documentation #1576

Conversation

kolchfa-aws commented Oct 14, 2022 • edited Loading

Checklist

Choose a reason for hiding this comment

alicejw1 Oct 14, 2022 • edited Loading

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

alicejw1 left a comment

Choose a reason for hiding this comment

ariamarble left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lizsnyder commented Oct 17, 2022

natebower left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kolchfa-aws commented Oct 14, 2022 •

edited

Loading

alicejw1 Oct 14, 2022 •

edited

Loading