[DOC]: Update Wizard naming convention (#1808)

* Revised naming convention and local environment steps

Signed-off-by: vagimeli <vagimeli@amazon.com>

* Revised intro para

Signed-off-by: vagimeli <vagimeli@amazon.com>

* revised line 38

Signed-off-by: vagimeli <vagimeli@amazon.com>

* Address tech review feedback

Signed-off-by: vagimeli <vagimeli@amazon.com>

* Updated UI graphics

Signed-off-by: vagimeli <vagimeli@amazon.com>

* Address doc review feedback

Signed-off-by: vagimeli <vagimeli@amazon.com>

* Address editorial feedback

Signed-off-by: vagimeli <vagimeli@amazon.com>

* Clarify wording line 26

Signed-off-by: vagimeli <vagimeli@amazon.com>

* Remove outdated related topics

Signed-off-by: vagimeli <vagimeli@amazon.com>

* Added redirect

Signed-off-by: vagimeli <vagimeli@amazon.com>

Signed-off-by: vagimeli <vagimeli@amazon.com>
This commit is contained in:
Melissa Vagi 2022-11-08 13:42:52 -07:00 committed by GitHub
parent 383cb93c0a
commit 71608d4ba6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 56 additions and 67 deletions

View File

@ -1,67 +0,0 @@
---
layout: default
title: Drag-and-drop wizard
nav_order: 8
---
The drag-and-drop visualization wizard is an experimental feature in OpenSearch 2.3. Therefore, we do not recommend the use of the drag-and-drop wizard in a production environment. For updates on the progress of drag and drop, or if you want to leave feedback that could help improve the feature, see the [Drag and drop git issue](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/2280).
{: .warning}
# Drag-and-drop wizard
You can use the drag-and-drop visualization wizard in OpenSearch Dashboards to create your data visualizations easily with just a few clicks or a single mouse gesture.
The drag-and-drop visualization wizard:
* Gives you an immediate view of your data without the need to preselect the visualization output.
* Gives you the flexibility to change visualization types and index patterns quickly.
* Gives you the ability to easily navigate between multiple screens.
<img src="{{site.url}}{{site.baseurl}}/images/drag-drop-ui.png" alt="Drag and drop user interface">
## Try out the wizard
You can try out the wizard locally or in the [OpenSearch playground](https://playground.opensearch.org/app/home#/).
### Try the wizard in OpenSearch playground
If you'd like to try out the wizard without installing OpenSearch locally, you can do so in the [OpenSearch Dashboards playground](https://playground.opensearch.org/app/wizard). The feature is enabled in the playground by default.
### Try the wizard locally
To enable the drag-and-drop wizard in your local installation, add the following flag to the `opensearch_dashboards.yml` file:
```yml
wizard.enabled: true
```
Then confirm that the feature is enabled in OpenSearch Dashboards:
1. To open OpenSearch Dashboards:
- If you're not running the security plugin, go to http://localhost:5601.
- If you're running the security plugin, go to https://localhost:5601 and log in with your username and password (default is admin/admin).
2. From the top menu, select **Management** **>** **Stack Management** **>** **Advanced Settings**.
<img src="{{site.url}}{{site.baseurl}}/images/stack-management-settings.png" alt="Stack management menu" width="200">
3. Select **Visualization**. The **Enable experimental visualizations** option should be turned on.
<img src="{{site.url}}{{site.baseurl}}/images/enable-experimental-viz.png" alt="Enable experimental visualizations" width="550">
To get started, follow the steps below to create a new visualization using the wizard:
1. From the top menu, select **Visualize** **>** **Create visualization** **>** **Wizard**.
<img src="{{site.url}}{{site.baseurl}}/images/drag-and-drop-viz-select.png" alt="Select Wizard visualization" width="350">
1. Drag and drop field names from the left column into the Configuration panel to generate a visualization.
Heres an example visualization. Your visualization will look different depending on your data and the fields you select.
<img src="{{site.url}}{{site.baseurl}}/images/drag-drop-generated-viz.png" alt="Visualization generated using sample data in the Wizard">
## Related topics
* [OpenSearch News, September 14, 2022](https://opensearch.org/)
* [Drag-and-drop visualizations demo at OpenSearch Community Meeting, August 16, 2022](https://forum.opensearch.org/t/opensearch-community-meeting-2022-0816/10323)
* [OpenSearch News, March 17, 2022](https://opensearch.org/blog/releases/2022/03/launch-announcement-1-3-0/)

56
_dashboards/visbuilder.md Normal file
View File

@ -0,0 +1,56 @@
---
layout: default
title: VisBuilder
nav_order: 8
redirect_from:
- /dashboards/drag-drop-wizard/
---
# VisBuilder
VisBuilder is an experimental feature and shouldn't be used in a production environment. For updates on its progress, or if you want to leave feedback that helps improve the feature, see the [GitHub issue](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/2280).
{: .warning}
You can use the VisBuilder visualization type in OpenSearch Dashboards to create data visualizations by using a drag-and-drop gesture. With VisBuilder you have:
* An immediate view of your data without the need to preselect the visualization output.
* The flexibility to change visualization types and index patterns quickly.
* The ability to easily navigate between multiple screens.
<img src="{{site.url}}{{site.baseurl}}/images/vis-builder-2.png" alt="VisBuilder new visualization start page">
## Try VisBuilder in the OpenSearch Dashboards playground
If you'd like to try out VisBuilder without installing OpenSearch locally, you can do so in the [Dashboards playground](https://playground.opensearch.org/app/vis-builder#/). VisBuilder is enabled by default.
## Try VisBuilder locally
VisBuilder is enabled by default. If you want to disable it, set the feature `flag vis_builder.enabled:` to `false` in the `opensearch_dashboards.yml` file as follows:
```
# Set the value of this setting to false to disable VisBuilder
# functionality in Visualization.
vis_builder.enabled: false
```
Follow these steps to create a new visualization using VisBuilder in your environment:
1. Open Dashboards:
- If you're not running the security plugin, go to http://localhost:5601.
- If you're running the security plugin, go to https://localhost:5601 and log in with your username and password (default is admin/admin).
2. Confirm that the **Enable experimental visualizations** option is turned on.
- From the top menu, select **Management** **>** **Stack Management** **>** **Advanced Settings**.
- Select **Visualization** and verify that the option is turned on.
<img src="{{site.url}}{{site.baseurl}}/images/enable-experimental-viz.png" alt="Enable experimental visualizations" width="600">
3. From the top menu, select **Visualize** **>** **Create visualization** **>** **VisBuilder**.
<img src="{{site.url}}{{site.baseurl}}/images/vis-builder-1.png" alt="Select the VisBuilder visualization type" width="550">
4. Drag and drop field names from the left column into the **Configuration** panel to generate a visualization.
Heres an example visualization. Your visualization will look different depending on your data and the fields you select.
<img src="{{site.url}}{{site.baseurl}}/images/drag-drop-generated-viz.png" alt="Visualization generated using sample data">

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 197 KiB

BIN
images/vis-builder-1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

BIN
images/vis-builder-2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 231 KiB