[DOC] Update Dev Tools for navigation changes #4874
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
requested review from
cwillum,
hdhalter,
kolchfa-aws,
Naarcha-AWS,
ananzh,
seanneumann,
AMoo-Miki and
natebower
as code owners
4 tasks
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
kolchfa-aws
approved these changes
Sep 13, 2023
_dashboards/dev-tools/index-dev.md
Outdated
| - Identify and fix bugs. For example, you can use the console to view logs and identify the cause of the problem. | ||
| - **Set up your OpenSearch Dashboards environment.** For example, you can use the console to configure authentication settings for your OpenSearch Dashboards instance. | ||
| - **[Run queries to explore your data]({{site.url}}{{site.baseurl}}/dashboards/dev-tools/run-queries/).** For example, you can use the console to run a query to find all the documents in your index that contain a specific word. | ||
| - **Debug problems with your queries.** For example, if your query is not returning the results you expect, you can use the console to look for error messages and identify the problem. |
There was a problem hiding this comment.
Suggested change
| - **Debug problems with your queries.** For example, if your query is not returning the results you expect, you can use the console to look for error messages and identify the problem. | |
| - **Debug problems with your queries.** For example, if your query is not returning the results you expect, you can use the console to identify the problem. |
_dashboards/dev-tools/index-dev.md
Outdated
| - **Set up your OpenSearch Dashboards environment.** For example, you can use the console to configure authentication settings for your OpenSearch Dashboards instance. | ||
| - **[Run queries to explore your data]({{site.url}}{{site.baseurl}}/dashboards/dev-tools/run-queries/).** For example, you can use the console to run a query to find all the documents in your index that contain a specific word. | ||
| - **Debug problems with your queries.** For example, if your query is not returning the results you expect, you can use the console to look for error messages and identify the problem. | ||
| - **Learn about the APIs in OpenSearch.** For example, you can use the API reference documentation linked in the console (select the question circle icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/question-circle.png" class="inline-icon" alt="question circle icon"/>{:/})) to look up the syntax for different API calls. |
There was a problem hiding this comment.
Suggested change
| - **Learn about the APIs in OpenSearch.** For example, you can use the API reference documentation linked in the console (select the question circle icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/question-circle.png" class="inline-icon" alt="question circle icon"/>{:/})) to look up the syntax for different API calls. | |
| - **Learn about the APIs in OpenSearch.** For example, you can use the API reference documentation linked in the console to look up the syntax for different API calls (select the question circle icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/question-circle.png" class="inline-icon" alt="question circle icon"/>{:/})). |
_dashboards/dev-tools/index-dev.md
Outdated
| - **Learn about the APIs in OpenSearch.** For example, you can use the API reference documentation linked in the console (select the question circle icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/question-circle.png" class="inline-icon" alt="question circle icon"/>{:/})) to look up the syntax for different API calls. | ||
| - **Develop custom visualizations.** For example, you can use the console to create Vega visualizations. | ||
| - **Customize the appearance and behavior of dashboards.** For example, you can use the console to customize dashboard visualization colors or to add new filters. | ||
| - **Identify and fix bugs.** For example, you can use the console to view logs and identify the cause of the problem. |
There was a problem hiding this comment.
I'm not sure I understand what this bullet point means. What kinds of logs? Dashboards logs or user custom logs? And bugs where?
There was a problem hiding this comment.
Deleted. If dev provides more details, I'll add later.
_dashboards/dev-tools/run-queries.md
Outdated
|
|
||
| To learn more about writing queries in OpenSearch domain-specific language (DSL), see [Query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl). | ||
| When writing queries using the console, there are common features that can help you write queries more efficiently and accurately. The following table describes these features and how you can use them. |
There was a problem hiding this comment.
I'm not sure "features" is the best word here. Maybe "actions"?
_dashboards/dev-tools/run-queries.md
Outdated
| Feature | Description | How to use | | ||
| --------|-------------|------------| | ||
| **Collapsing or expanding a query** | Helpful to use when you have a long query or only want to focus on a specific part of the query. | To hide or show details of your query, select the expander arrow ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/arrow-down-icon.png" class="inline-icon" alt="arrow down icon"/>{:/}) next to the line number. | | ||
| **OpenSearch search language** | Helpful to use when you need flexibility in writing complex queries. | To learn how to use the OpenSearch query domain-specific language (DSL), see [Query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/). | |
There was a problem hiding this comment.
This is the only outlier here because it's not an action. Maybe move it to before the table as a sentence?
There was a problem hiding this comment.
Also, it's pretty much the only option in DevTools, right? Except for sending everything as a query parameter. So "helpful to use" does not apply.
There was a problem hiding this comment.
Revised. See line 15.
_dashboards/dev-tools/run-queries.md
Outdated
| **OpenSearch search language** | Helpful to use when you need flexibility in writing complex queries. | To learn how to use the OpenSearch query domain-specific language (DSL), see [Query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/). | | ||
| **Single-line comments** | Helpful to use when you want to explain what the query does or to exclude parts of a query. | To add notes that are not interpreted by OpenSearch to your queries, use a hash (`#`) to start the single-line comment. | | ||
| **Autocomplete** | Helpful to use when for suggestions for correct syntax and keywords, avoiding typos and errors, and reducing the amount of typing you do. | To define your preferences for autocomplete suggestions, configure them in **Settings**. | | ||
| **Auto indenting** | Helpful to use to put the request body on a single line, which is useful for working with [bulk APIs]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/). Auto indenting a collapsed query expands it. | To use auto indent, select the queries that you want to format, then select the wrench icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/wrench-icon.png" class="inline-icon" alt="wrench icon"/>{:/}), and choose **Auto indent**. | |
There was a problem hiding this comment.
Suggested change
| **Auto indenting** | Helpful to use to put the request body on a single line, which is useful for working with [bulk APIs]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/). Auto indenting a collapsed query expands it. | To use auto indent, select the queries that you want to format, then select the wrench icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/wrench-icon.png" class="inline-icon" alt="wrench icon"/>{:/}), and choose **Auto indent**. | | |
| **Auto indenting** | Helpful to use when you want to put the request body on a single line, which is useful for working with [bulk APIs]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/). Auto indenting a collapsed query expands it. | To use auto indent, select the queries that you want to format, then select the wrench icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/wrench-icon.png" class="inline-icon" alt="wrench icon"/>{:/}), and choose **Auto indent**. | |
_dashboards/dev-tools/run-queries.md
Outdated
| **Autocomplete** | Helpful to use when for suggestions for correct syntax and keywords, avoiding typos and errors, and reducing the amount of typing you do. | To define your preferences for autocomplete suggestions, configure them in **Settings**. | | ||
| **Auto indenting** | Helpful to use to put the request body on a single line, which is useful for working with [bulk APIs]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/). Auto indenting a collapsed query expands it. | To use auto indent, select the queries that you want to format, then select the wrench icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/wrench-icon.png" class="inline-icon" alt="wrench icon"/>{:/}), and choose **Auto indent**. | | ||
| **Request history** | Helpful for displaying up to the 500 most recent requests that OpenSearch ran successfully. | To view request history, select **History** from the top menu. If you select the request you want to view from the left pane, the query is shown in the right pane. To copy the query into the editor pane, select the query text and then select **Apply**. To clear the history, select **Clear**. | | ||
| **Keyboard shortcuts** | Helpful for saving time, improving efficiency, and avoiding typos and errors. | To view all available keyboard shortcuts, select **Help** from the top menu. | |
There was a problem hiding this comment.
Some of these descriptions are probably self-explanatory. I would remove the descriptions and just list what the command does in "how to use".
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
added
Closed - Complete
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
added a commit
that referenced
this pull request
Sep 19, 2023
Update UI screenshots and make copy edits to content --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
harshavamsi
pushed a commit
to harshavamsi/documentation-website
that referenced
this pull request
Oct 31, 2023
Update UI screenshots and make copy edits to content --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
vagimeli
added a commit
that referenced
this pull request
Dec 21, 2023
Update UI screenshots and make copy edits to content --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates documentation for 2.10 Dashboards navigation changes
Issues Resolved
#4550
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.