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

Add Maps to Dashboard #2903

Merged
merged 15 commits into from
Feb 28, 2023
Merged

Add Maps to Dashboard #2903

merged 15 commits into from
Feb 28, 2023

Conversation

carolxob
Copy link
Contributor

@carolxob carolxob commented Feb 14, 2023

Description

Describes how to add Maps to the Dashboard.

Issues Resolved

Closes #2656

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: carolxob <carolxob@amazon.com>
@carolxob carolxob self-assigned this Feb 14, 2023
@carolxob carolxob requested a review from a team as a code owner February 14, 2023 23:15
Signed-off-by: carolxob <carolxob@amazon.com>
Signed-off-by: carolxob <carolxob@amazon.com>
@carolxob carolxob added 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 backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 labels Feb 15, 2023
Signed-off-by: carolxob <carolxob@amazon.com>
Signed-off-by: carolxob <carolxob@amazon.com>
Signed-off-by: carolxob <carolxob@amazon.com>
@hdhalter
Copy link
Contributor

@carolxob - is this feature only for 2.6? If so, we don't backport unless they are backporting the functionality.

@hdhalter hdhalter added the release-notes PR: Include this PR in the automated release notes label Feb 21, 2023
@carolxob
Copy link
Contributor Author

carolxob commented Feb 23, 2023

@junqiu-lei @VijayanB This is ready for tech review. Thanks!


## Getting started

To get started, perform the following steps:
Copy link
Member

Choose a reason for hiding this comment

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

This part may need update, the entrypoint is Dashboard instead of Visualize

layout: default
title: Adding Maps to your Dashboard
grand_parent: Building data visualizations
parent: Using coordinate and region maps
Copy link
Member

Choose a reason for hiding this comment

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

This feature isn't related to coordinate and region maps, I think it belongs to _dashboards/maps-plugin.md

@junqiu-lei
Copy link
Member

I saw this PR tagged with back-port to 2.0 - 2.5, this new feature is only available since 2.6, not sure if we need backport them. Thanks!

@carolxob carolxob removed 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 backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 labels Feb 23, 2023
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
@kolchfa-aws
Copy link
Collaborator

@VijayanB @junqiu-lei Could you tech review this PR please?

@kolchfa-aws kolchfa-aws self-assigned this Feb 24, 2023
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Copy link
Contributor

@cwillum cwillum left a comment

Choose a reason for hiding this comment

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

Looks great. Steps are very clear to me.


To get started, perform the following steps:
You can create a new map from the **Maps** or **Visualize** workflows by performing the following steps:
Copy link
Contributor

Choose a reason for hiding this comment

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

Feel free to disregard this. I'm looking at the great screenshots you added. Are the "workflows" actual UI elements? If they're not items you can actually see labeled or interact with, I'm not sure we need to make them bold face. But I'm not in the UI. So move on if this comment isn't valid.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, they are actually menu items in the top menu... I don't know whether there is a better word than "workflow" here. Let's ask @natebower


You can now see the default OpenSearch basemap.

To examine the **Default map** layer configuration, in the **Layers** panel on the upper left of the map, select **Default map**, as shown in the following image.
Copy link
Contributor

Choose a reason for hiding this comment

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

"... in the Layers panel, in the upper-left corner of the map, ..."
(suggestion only-feel free to disregard)

1. On the top menu bar, go to **OpenSearch Dashboards > Dashboard**.
1. Select the dashboard you want to open from the list.
1. In the upper right corner, select **Edit**.
Copy link
Contributor

Choose a reason for hiding this comment

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

upper-right corner

1. In the **New Visualization** dialog, select **Maps**.
1. Add any default map, layers, and tooltips to the map.
1. In the upper right corner, select the **Save** button.
Copy link
Contributor

Choose a reason for hiding this comment

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

upper-right corner

## Editing a map from a dashboard

1. In the dashboard, select the gear icon in the upper right corner of the map you want to edit.
Copy link
Contributor

Choose a reason for hiding this comment

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

upper-right corner

1. Select **Edit maps**.
1. Edit the map.
1. In the upper right corner, select the **Save** button.
Copy link
Contributor

Choose a reason for hiding this comment

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

upper-right corner

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@kolchfa-aws Just some easy word replacements. Let me know if you have any questions. Thanks!

_dashboards/visualize/maps.md Outdated Show resolved Hide resolved
_dashboards/visualize/maps.md Outdated Show resolved Hide resolved

1. On the top menu bar, go to **OpenSearch Dashboards > Visualize**.
1. Select the **Create visualization** button.
1. In the **New Visualization** dialog, select **Maps**.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Global: Use "choose" to describe moving to a UI component such as a tab or pane or taking action on a button or menu.

_dashboards/visualize/maps.md Outdated Show resolved Hide resolved
_dashboards/visualize/maps.md Outdated Show resolved Hide resolved
_dashboards/visualize/maps.md Outdated Show resolved Hide resolved
_dashboards/visualize/maps.md Outdated Show resolved Hide resolved
_dashboards/visualize/maps.md Outdated Show resolved Hide resolved
_dashboards/visualize/maps.md Outdated Show resolved Hide resolved
_dashboards/visualize/maps.md Outdated Show resolved Hide resolved
kolchfa-aws and others added 2 commits February 27, 2023 10:24
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
@kolchfa-aws kolchfa-aws merged commit 5303f8f into main Feb 28, 2023
@Naarcha-AWS Naarcha-AWS deleted the maps-dashboard branch March 28, 2024 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dashboards release-notes PR: Include this PR in the automated release notes v2.6.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Add Maps to dashboard
8 participants