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.

Sign up for GitHub

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

Jump to bottom

[Doc] update geoJSON example file to prevent errors #1277

Merged
merged 11 commits into from
Sep 26, 2022
Merged

[Doc] update geoJSON example file to prevent errors #1277

merged 11 commits into from
Sep 26, 2022

Conversation

alicejw1
Copy link
Contributor

@alicejw1 alicejw1 commented Sep 21, 2022 •
edited
Loading

Signed-off-by: alicejw [email protected]

Description

replace geoJSON file provided as an example with a file that can be used in the Dashboards without any errors. see issue comment: #794 (comment)
Rewrites to include both descriptive plugin names and actual names for better searches and discoverability.

Note: file was tested in the Dashboards successfully without any errors.
added new screen captures with blue borders.

Added prerequisite callout to indicate required plugins to create a custom region map with GeoJSON. See screen shot to show rendered note:
prerequisite-callout

Issues Resolved

N/A - iterative change from closed issue.

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

@alicejw1 alicejw1 added the 2 - In progress Issue/PR: The issue or PR is in progress. label Sep 21, 2022
@alicejw1 alicejw1 added this to the 2022-Q3 milestone Sep 21, 2022
@alicejw1 alicejw1 self-assigned this Sep 21, 2022
@alicejw1 alicejw1 marked this pull request as ready for review September 21, 2022 17:34
@alicejw1 alicejw1 requested a review from a team as a code owner September 21, 2022 17:34
@alicejw1 alicejw1 added 4 - Doc review PR: Doc review in progress backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Sep 21, 2022
@alicejw1
image rename
303a019 
Signed-off-by: alicejw <[email protected]>
@kolchfa-aws
Copy link
Collaborator

Hey @Shivamdhar, is this what we should see when we upload the new geojson file? Is there a way to make the region border in color (like red)? Thank you!
image

@alicejw1
Copy link
Contributor Author

Hi @kolchfa-aws, I made some updates after we discussed the steps and reorg. Let me know what you think. thanks

vagimeli
vagimeli suggested changes Sep 24, 2022
View reviewed changes
Copy link
Contributor

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

@alicejw-aws I have few comments. Looks good overall.

@alicejw1 alicejw1 merged commit a1d79db into opensearch-project:main Sep 26, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 26, 2022
@alicejw1 @github-actions
[Doc] update geoJSON example file to prevent errors (#1277)
9455604 
* for geoJSON file that has same start/endpoints for each polygon. see issue with more info #794 (comment)

Signed-off-by: alicejw <[email protected]>

* for additional images with borders and fixed errors in example GeoJSON file so it is cut and paste ready to use

Signed-off-by: alicejw <[email protected]>

* rename new image file because replacing file with same name caused build conflict

Signed-off-by: alicejw <[email protected]>

* image rename

Signed-off-by: alicejw <[email protected]>

* for doc reviewer edits and more clarification to procedural steps

Signed-off-by: alicejw <[email protected]>

* fix typo in UI name 'Region Map' visualization type

Signed-off-by: alicejw <[email protected]>

* to add prerequisite callout for the two required plugins

Signed-off-by: alicejw <[email protected]>

* remove commented-out note for link. unnecessary

Signed-off-by: alicejw <[email protected]>

* for doc review updates - changed example JSON file to include only 2 counties, and other rewrites

Signed-off-by: alicejw <[email protected]>

* remove modified region map and use original map with 2 counties

Signed-off-by: alicejw <[email protected]>

* we decided to show the grey outlined regions in the image

Signed-off-by: alicejw <[email protected]>

Signed-off-by: alicejw <[email protected]>
(cherry picked from commit a1d79db)
This was referenced Sep 26, 2022
Merged
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 26, 2022
@alicejw1 @github-actions
[Doc] update geoJSON example file to prevent errors (#1277)
0006b2d 
* for geoJSON file that has same start/endpoints for each polygon. see issue with more info #794 (comment)

Signed-off-by: alicejw <[email protected]>

* for additional images with borders and fixed errors in example GeoJSON file so it is cut and paste ready to use

Signed-off-by: alicejw <[email protected]>

* rename new image file because replacing file with same name caused build conflict

Signed-off-by: alicejw <[email protected]>

* image rename

Signed-off-by: alicejw <[email protected]>

* for doc reviewer edits and more clarification to procedural steps

Signed-off-by: alicejw <[email protected]>

* fix typo in UI name 'Region Map' visualization type

Signed-off-by: alicejw <[email protected]>

* to add prerequisite callout for the two required plugins

Signed-off-by: alicejw <[email protected]>

* remove commented-out note for link. unnecessary

Signed-off-by: alicejw <[email protected]>

* for doc review updates - changed example JSON file to include only 2 counties, and other rewrites

Signed-off-by: alicejw <[email protected]>

* remove modified region map and use original map with 2 counties

Signed-off-by: alicejw <[email protected]>

* we decided to show the grey outlined regions in the image

Signed-off-by: alicejw <[email protected]>

Signed-off-by: alicejw <[email protected]>
(cherry picked from commit a1d79db)
alicejw1 added a commit that referenced this pull request Sep 26, 2022
@opensearch-trigger-bot @alicejw1
[Doc] update geoJSON example file to prevent errors (#1277) (#1314)
75d1ec8 
* for geoJSON file that has same start/endpoints for each polygon. see issue with more info #794 (comment)

Signed-off-by: alicejw <[email protected]>

* for additional images with borders and fixed errors in example GeoJSON file so it is cut and paste ready to use

Signed-off-by: alicejw <[email protected]>

* rename new image file because replacing file with same name caused build conflict

Signed-off-by: alicejw <[email protected]>

* image rename

Signed-off-by: alicejw <[email protected]>

* for doc reviewer edits and more clarification to procedural steps

Signed-off-by: alicejw <[email protected]>

* fix typo in UI name 'Region Map' visualization type

Signed-off-by: alicejw <[email protected]>

* to add prerequisite callout for the two required plugins

Signed-off-by: alicejw <[email protected]>

* remove commented-out note for link. unnecessary

Signed-off-by: alicejw <[email protected]>

* for doc review updates - changed example JSON file to include only 2 counties, and other rewrites

Signed-off-by: alicejw <[email protected]>

* remove modified region map and use original map with 2 counties

Signed-off-by: alicejw <[email protected]>

* we decided to show the grey outlined regions in the image

Signed-off-by: alicejw <[email protected]>

Signed-off-by: alicejw <[email protected]>
(cherry picked from commit a1d79db)

Co-authored-by: Alice Williams <[email protected]>
alicejw1 added a commit that referenced this pull request Sep 26, 2022
@opensearch-trigger-bot @alicejw1
[Doc] update geoJSON example file to prevent errors (#1277) (#1313)
f4c8f97 
* for geoJSON file that has same start/endpoints for each polygon. see issue with more info #794 (comment)

Signed-off-by: alicejw <[email protected]>

* for additional images with borders and fixed errors in example GeoJSON file so it is cut and paste ready to use

Signed-off-by: alicejw <[email protected]>

* rename new image file because replacing file with same name caused build conflict

Signed-off-by: alicejw <[email protected]>

* image rename

Signed-off-by: alicejw <[email protected]>

* for doc reviewer edits and more clarification to procedural steps

Signed-off-by: alicejw <[email protected]>

* fix typo in UI name 'Region Map' visualization type

Signed-off-by: alicejw <[email protected]>

* to add prerequisite callout for the two required plugins

Signed-off-by: alicejw <[email protected]>

* remove commented-out note for link. unnecessary

Signed-off-by: alicejw <[email protected]>

* for doc review updates - changed example JSON file to include only 2 counties, and other rewrites

Signed-off-by: alicejw <[email protected]>

* remove modified region map and use original map with 2 counties

Signed-off-by: alicejw <[email protected]>

* we decided to show the grey outlined regions in the image

Signed-off-by: alicejw <[email protected]>

Signed-off-by: alicejw <[email protected]>
(cherry picked from commit a1d79db)

Co-authored-by: Alice Williams <[email protected]>
@Shivamdhar
Copy link

Hey @Shivamdhar, is this what we should see when we upload the new geojson file? Is there a way to make the region border in color (like red)? Thank you! image

Hello! yes, for California counties it looks correct. Unfortunately we don't have an option to change border color at the moment.

Naarcha-AWS pushed a commit that referenced this pull request Oct 6, 2022
@alicejw1 @Naarcha-AWS
[Doc] update geoJSON example file to prevent errors (#1277)
e969a14 
* for geoJSON file that has same start/endpoints for each polygon. see issue with more info #794 (comment)

Signed-off-by: alicejw <[email protected]>

* for additional images with borders and fixed errors in example GeoJSON file so it is cut and paste ready to use

Signed-off-by: alicejw <[email protected]>

* rename new image file because replacing file with same name caused build conflict

Signed-off-by: alicejw <[email protected]>

* image rename

Signed-off-by: alicejw <[email protected]>

* for doc reviewer edits and more clarification to procedural steps

Signed-off-by: alicejw <[email protected]>

* fix typo in UI name 'Region Map' visualization type

Signed-off-by: alicejw <[email protected]>

* to add prerequisite callout for the two required plugins

Signed-off-by: alicejw <[email protected]>

* remove commented-out note for link. unnecessary

Signed-off-by: alicejw <[email protected]>

* for doc review updates - changed example JSON file to include only 2 counties, and other rewrites

Signed-off-by: alicejw <[email protected]>

* remove modified region map and use original map with 2 counties

Signed-off-by: alicejw <[email protected]>

* we decided to show the grey outlined regions in the image

Signed-off-by: alicejw <[email protected]>

Signed-off-by: alicejw <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kolchfa-aws kolchfa-aws kolchfa-aws approved these changes

@vagimeli vagimeli vagimeli approved these changes

Assignees

@alicejw1 alicejw1

Labels
4 - Doc review PR: Doc review in progress backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3
Projects
None yet
Milestone
2022-Q3
Development

Successfully merging this pull request may close these issues.
4 participants
@alicejw1 @kolchfa-aws @Shivamdhar @vagimeli