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

Adds advanced settings descriptions #6928

Merged
merged 62 commits into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
62 commits
Select commit Hold shift + click to select a range
b926737
Adds advanced settings descriptions
vagimeli Apr 9, 2024
04b1dd5
Merge branch 'main' into add-settings-descriptions
vagimeli Apr 29, 2024
db84813
Merge branch 'main' into add-settings-descriptions
vagimeli May 3, 2024
88b1462
Update quickstart appearance theme section and screenshots
vagimeli May 3, 2024
9eec552
Merge branch 'main' into add-settings-descriptions
vagimeli May 3, 2024
f56e743
Merge branch 'main' into add-settings-descriptions
vagimeli May 8, 2024
3118b22
Update _dashboards/management/advanced-settings.md
vagimeli May 8, 2024
a9c1e29
Address tech review feedback
vagimeli May 8, 2024
a48e318
Copy edits
vagimeli May 8, 2024
278a93c
Copy edits
vagimeli May 8, 2024
dae4b84
Copy edits
vagimeli May 8, 2024
6c0e97e
Merge branch 'main' into add-settings-descriptions
vagimeli May 9, 2024
a8581d0
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
1845c74
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
bdb0007
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
68e4392
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
c9c8703
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
56086b6
Update _dashboards/quickstart.md
vagimeli May 10, 2024
454c52c
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
1014279
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
c2d0d14
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
2ef6265
Update _dashboards/quickstart.md
vagimeli May 10, 2024
b912924
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
a09fd2e
Update _dashboards/quickstart.md
vagimeli May 10, 2024
c24c79f
Update _dashboards/quickstart.md
vagimeli May 10, 2024
90e991e
Update _dashboards/quickstart.md
vagimeli May 10, 2024
0d7dbb4
Update _dashboards/quickstart.md
vagimeli May 10, 2024
3087d7a
Update _dashboards/quickstart.md
vagimeli May 10, 2024
3303962
Update _dashboards/quickstart.md
vagimeli May 10, 2024
ac38fba
Update _dashboards/quickstart.md
vagimeli May 10, 2024
749aacc
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
ae1f6a2
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
ad1acae
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
dc7e84a
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
d00193c
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
09bef29
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
e3b9d3f
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
1227634
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
6091dee
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
2e7e78a
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
9996737
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
d892878
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
aabeb33
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
31eac67
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
e46fb48
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
2fabf92
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
79d3b0f
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
9fb142f
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
1e0ea0a
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
74a1c80
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
da4e1d8
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
34a0a55
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
4e8c6d8
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
626db2f
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
824e6d8
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
7942749
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
5b245a6
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
6f3d3df
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
0d21534
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
d213b7a
Update _dashboards/management/advanced-settings.md
vagimeli May 10, 2024
d9a2fa7
Update advanced-settings.md
vagimeli May 10, 2024
855c0e5
Merge branch 'main' into add-settings-descriptions
vagimeli May 10, 2024
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
141 changes: 137 additions & 4 deletions _dashboards/management/advanced-settings.md

Large diffs are not rendered by default.

63 changes: 45 additions & 18 deletions _dashboards/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,17 @@
- **Adding sample data:** Use preloaded visualizations, dashboards, and other tools to explore OpenSearch Dashboards before adding your own data.
- **Using the Discover application:** Analyze your data to gain insights.
- **Using the Dashboards application:** Create and store data visualizations.
- **Turning dark mode on or off:** Change the Dashboards theme.
- **Customizing the appearance theme:** Quickly change the OpenSearch Dashboards appearance theme from the home page.

To dock or undock the navigation pane, select the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/menu-icon.png" class="inline-icon" alt="menu icon"/>{:/} icon and then **Dock navigation** or **Undock navigation**. The OpenSearch Dashboards home page is shown in the following image.
The OpenSearch Dashboards' default view is shown in the following image.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/opensearch-dashboards-home.png" alt="OpenSearch Dashboards home page" width="700">
<img src="{{site.url}}{{site.baseurl}}//images/dashboards/home-page-nav.png" alt="OpenSearch Dashboards interface default view" width="700">

{::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/alert-icon.png" class="inline-icon" alt="alert icon"/>{:/} **Note**<br>Before you get started, make sure you've installed OpenSearch and OpenSearch Dashboards. For information about installation and configuration, see [Install and configure OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/) and [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/index/).
## Docking the navigation menu

To dock or undock the navigation pane, select the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/menu-icon.png" class="inline-icon" alt="menu icon"/>{:/} icon and then **Dock navigation** or **Undock navigation**.

Check failure on line 25 in _dashboards/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _dashboards/quickstart.md#L25

[OpenSearch.Spelling] Error: undock. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: undock. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_dashboards/quickstart.md", "range": {"start": {"line": 25, "column": 12}}}, "severity": "ERROR"}

Check failure on line 25 in _dashboards/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _dashboards/quickstart.md#L25

[OpenSearch.Spelling] Error: Undock. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: Undock. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_dashboards/quickstart.md", "range": {"start": {"line": 25, "column": 213}}}, "severity": "ERROR"}
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

Before continuing with the following tutorials, make sure you've installed OpenSearch and OpenSearch Dashboards. For information about installation and configuration, see [Install and configure OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/) and [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/index/).
{: .note}

## Adding sample data
Expand All @@ -33,7 +37,7 @@
1. On the OpenSearch Dashboards **Home** page, choose **Add sample data**. Alternatively, choose **Add data** on the upper-right toolbar.
2. On the **Add sample data** page, choose the dataset(s) you want to add to Dashboards. The following image shows the available sample datasets.

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/add-sample-data-2.png" alt="Adding sample data window" width="700">
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/add-sample.png" alt="Adding sample data window" width="700">

## Using the Discover application

Expand All @@ -57,7 +61,7 @@

## Using the Dashboards application

With **Dashboards**, you can:
With [**Dashboards**]({{site.url}}{{site.baseurl}}/dashboards/dashboard/index/), you can:

- Display data in a single view.
- Build dynamic dashboards.
Expand All @@ -71,11 +75,11 @@
3. To add other panels to the dashboard, select the **Edit** button and then choose **Add** from the toolbar. The **Add panels** window opens.
4. In the search toolbar in the **Add panels** window, search for and select the existing panel **[Flights] Delay Buckets**. A pop-up message confirms that you've added the panel.
5. Select close `x` to exit the **Add panels** window.
6. The newly added panel is now displayed on the dashboard.
6. The newly added panel is now displayed as the last panel on the dashboard.

The resulting view is shown in the following image.

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/add-panel2.png" alt="Add panel tutorial screen view" width="700">
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/add-dash-panel.png" alt="Add panel view" width="700">

For information about using a specific data visualization type, such as VisBuilder, go to [Building data visualizations]({{site.url}}{{site.baseurl}}/dashboards/visualize/viz-index/). For information about using dashboards and visualizations in **Observability**, go to [Observability]({{site.url}}{{site.baseurl}}/observing-your-data/).
{: .note}
Expand All @@ -86,33 +90,56 @@

Using the **[Flights] Global Flight Dashboard** dashboard, follow these steps to further analyze and filter the sample flight data:

1. On the **[Flights] Airline Carrier** panel, choose **OpenSearch-Air**. The dashboard updates automatically.
1. On the **[Flights] Airline Carrier** panel, choose **OpenSearch-Air**. The dashboard updates automatically, as shown in the following GIF.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
2. Choose **Save** to save the dashboard.

![Filter data demo]({{site.url}}{{site.baseurl}}/images/dashboards/airline-carrier.gif)

Alternatively, you can use the dashboard toolbar to apply filters by following these steps:

1. In the dashboard toolbar, choose **Add filter**.
2. From the **Field**, **Operator**, and **Value** dropdown lists, choose **Carrier**, **is**, and **OpenSearch-Air**, respectively, as shown in the following image.
2. From the **Field**, **Operator**, and **Value** dropdown lists, choose **Carrier**, **is**, and **OpenSearch-Air**, respectively.
3. Choose **Save**. The dashboard updates automatically.

The resulting view is shown in the following image.

<img src="{{site.url}}{{site.baseurl}}//images/<insert image>" alt="Screenshot of Dashboard tutorial panel view" width="700">
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/filter-data-dash.png" alt="Dashboards tutorial panel view" width="700">

## Customizing the appearance theme
Introduced 2.14
{: .label .label-purple }

Light mode is the default appearance theme in OpenSearch Dashboards. You can customize the appearance theme to suit your preferences. The available options include light mode, dark mode, and using your browser's settings.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

### Enabling the appearance theme setting

## Turning dark mode on or off
The appearance theme setting is enabled or disabled through **Advanced Settings** and requires admin permissions. If you do not see the {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/theme-icon.png" class="inline-icon" alt="theme icon"/>{:/} icon on the upper right of the **Home** page, then the setting is likely disabled. To enable it, contact your admin.

Changing the Dashboards theme requires admin permissions. If you are an admin, follow these steps:
### Changing the appearance theme for all users

Admins can change the appearance theme for all users of their OpenSearch Dashboards instance through **Advanced Settings**:

1. Navigate to **Management** > **Dashboards Management** > **Advanced Settings**.
2. Scroll down to the **Appearance** section and locate the **Dark mode** option.
3. Use the toggle switch to turn dark mode on or off for all users of your Dashboards instance, as shown in the image following these steps.
4. Select the **Save changes** button and then the **Reload** button. The updated theme is applied immediately.
2. Scroll to the **Appearance** section and toggle `theme:darkMode` on or off.
3. Select the **Save changes** button, then the **Reload** button. The updated theme is applied immediately.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/dark-mode.png" alt="Dark mode view" width="700">

### Changing your appearance theme from the Home page
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

If the setting is enabled, you can change your OpenSearch Dashboards appearance theme from the **Home** page:
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

1. Select {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/theme-icon.png" class="inline-icon" alt="theme icon"/>{:/} icon on the upper right.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
2. Choose one of the following theme settings: **Light**, **Dark**, or **Use browser settings**.
3. Select **Apply**. The interface appearance automatically changes.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

A view is shown in the following image.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's clarify. A view of what? Or just "The X is shown..."

vagimeli marked this conversation as resolved.
Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/appearance-home.png" alt="Theme icon on Home page" width="250">

## Next steps

- Go to [Building data visualizations]({{site.url}}{{site.baseurl}}/dashboards/visualize/viz-index/) to learn more about Dashboards data visualizations.
- Go to [Building data visualizations]({{site.url}}{{site.baseurl}}/dashboards/visualize/viz-index/) to learn more about data visualizations.
- Go to [Creating dashboards]({{site.url}}{{site.baseurl}}/dashboards/quickstart-dashboards/) to learn more about creating dashboards.
- Go to [Analyzing data]({{site.url}}{{site.baseurl}}/dashboards/discover/index-discover/) to learn more about using Dashboards to analyze data.
- Go to [Ingest APIs]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/index/) and [Ingest pipelines]({{site.url}}{{site.baseurl}}/ingest-pipelines/) to learn more about using OpenSearch for data ingestion.
- Go to [Ingest APIs]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/index/) and [Ingest pipelines]({{site.url}}{{site.baseurl}}/ingest-pipelines/) to learn more about data ingestion using OpenSearch.
Binary file added images/dashboards/add-dash-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/dashboards/add-sample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/dashboards/advanced-settings-ui.png
Binary file not shown.
Binary file added images/dashboards/advanced-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/airline-carrier.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/appearance-home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/filter-data-dash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/home-page-nav.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/icons/theme-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/theme-icon.png
Copy link
Member

Choose a reason for hiding this comment

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

duplicate icon file with images/icons/theme-icon.png?

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading