Update quickstart to include dashboards #6004

vagimeli · 2023-12-28T00:25:35Z

Description

Revises quickstart to include redesign homepage and update tutorial screenshots

Issues Resolved

Addresses Dark Mode only in #6344

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: Melissa Vagi <[email protected]>

kavilla

will need to check if the new home page needs to be configured. technically there are integration points within the home page to avoid breaking changes. but it is the home page so even breakages shouldn't be too big of an issue.

_dashboards/quickstart.md

kavilla · 2024-01-09T18:07:48Z

_dashboards/quickstart.md

-2. Choose **Add data** to add the datasets, as shown in the following image.
+- **Enhanced user experience:** Improves your experience by incorporating intuitive navigation, streamlined workflows, and a visually appealing interface. 
+- **Optimized data accessibility:** Presents critical information in a more effective manner, making it easier for you to interpret and analyze data.
+- **Responsive design for multi-platform access:** Prioritizes responsive design principles, ensuring seamless access and functionality across various devices and screen sizes. 


will need to vet this. we don't have any visual regression tests for verifying this. could be accurate now but wrong and we wont know it automatically.

@BSFishy Will you review these lines to make sure the content is accurate? Thanks!

This is accurate. The page extensively uses OUI and properly utilizes the responsive aspects of it, so it should look good on all page sizes. The only disclaimer would be that all within sections are completely owned by plugins, so while the current homepage is responsive, there is not really any guarantee that it is.

Given that the new homepage layout will not be default, but rather will be behind a switch, can we adjust the docs accordingly?

@wbeckler Are you asking that we put in some text around the new Discover toggle (Data Explorer) needing to be activated by the user?

@BSFishy , can you take a look at this and confirm that the homepage plan for 2.12 (keeping current as default and adding a setting to try out the new one) is consistent with these docs changes?

@vagimeli The new homepage has its own separate toggle from the Discover/Data Explorer toggle. I think it defaults to old homepage. I'm also not sure if the PR will make it in for 2.12 as it's still Draft: opensearch-project/OpenSearch-Dashboards#5613

@wbeckler We have specific Discover documentation that I can update when it's ready. this quickstart is intended to cover OpenSearch Dashboards tools generally. Is there any specific information we should remove? Currently, the OpenSearch Playground shows the updates, so I think we need to update the quickstart for relevancy.

@kgcreative Will you review the updates at your availability to make sure the UX topics and screenshots are appropriately captured? Thank you.

Signed-off-by: Melissa Vagi <[email protected]>

vagimeli · 2024-01-24T21:03:35Z

@brijos This is the PR for doc updates to the Quickstart for Dashboards redesign updates

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>

vagimeli · 2024-02-27T20:58:39Z

@vagimeli As you'll see, I edited and reorganized this pretty liberally, so take a look and let me know if you have any questions about my changes (or if you disagree 😄). Please tag me when complete so that I can reread and approve. Thanks!

@natebower Thank you for your rewrites. You tightened the writing :) I accepted your suggestions.

Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

natebower · 2024-02-28T12:13:50Z

@vagimeli As you'll see, I edited and reorganized this pretty liberally, so take a look and let me know if you have any questions about my changes (or if you disagree 😄). Please tag me when complete so that I can reread and approve. Thanks!

@natebower Thank you for your rewrites. You tightened the writing :) I accepted your suggestions.

natebower

@vagimeli Assuming all my comments/changes were clear, we should be good to go (apologies for accidentally closing and reopening). LGTM!

Signed-off-by: Melissa Vagi <[email protected]>

natebower

@vagimeli Additional modified content is now edited.

natebower · 2024-02-29T12:32:41Z

_dashboards/discover/index-discover.md


+- Install [OpenSearch Dashboards](https://opensearch.org/downloads.html).
+- Add sample data or import your own data into OpenSearch. Go to [OpenSearch Dashboards quickstart guide]({{site.url}}{{site.baseurl}}/dashboards/quickstart/) to learn about adding sample datasets. Go to [Managing indexes]({{site.url}}{{site.baseurl}}/im-plugin/index/) to learn about importing your own data.


Suggested change

- Add sample data or import your own data into OpenSearch. Go to [OpenSearch Dashboards quickstart guide]({{site.url}}{{site.baseurl}}/dashboards/quickstart/) to learn about adding sample datasets. Go to [Managing indexes]({{site.url}}{{site.baseurl}}/im-plugin/index/) to learn about importing your own data.

- Add sample data or import your own data into OpenSearch. Go to the [OpenSearch Dashboards quickstart guide]({{site.url}}{{site.baseurl}}/dashboards/quickstart/) to learn about adding sample datasets. Go to [Managing indexes]({{site.url}}{{site.baseurl}}/im-plugin/index/) to learn about importing your own data.

_dashboards/discover/index-discover.md

natebower · 2024-02-29T12:39:13Z

_dashboards/discover/index-discover.md


   <img src="{{site.url}}{{site.baseurl}}/images/dashboards/visualization-flight.png" alt="Data visualization of flight sample data field destination" width="700"/>

 ## Setting alerts

-You can set alerts to notify you when your data changes beyond the thresholds you define. To learn more about using **Discover** to create and manage alerts, see [Alerting dashboards and visualizations]({{site.url}}{{site.baseurl}}/observing-your-data/alerting/dashboards-alerting/).
+Set alerts to notify you when your data changes beyond the thresholds you define. Go to [Alerting dashboards and visualizations]({{site.url}}{{site.baseurl}}/observing-your-data/alerting/dashboards-alerting/) to learn about creating and managing alerts.


Do we want to keep "You can set", given that this is directly under a heading?

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>

vagimeli · 2024-02-29T16:39:04Z

@vagimeli Assuming all my comments/changes were clear, we should be good to go (apologies for accidentally closing and reopening). LGTM!

Thank you!

Signed-off-by: Melissa Vagi <[email protected]>

Update quickstart and discover content for relevancy to current Dashboards 2.12 --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit 7152f90) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Update quickstart and discover content for relevancy to current Dashboards 2.12 --------- (cherry picked from commit 7152f90) Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>

Update quickstart and discover content for relevancy to current Dashboards 2.12 --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>

Update quickstart to include dashboards redesign

9da1e70

Signed-off-by: Melissa Vagi <[email protected]>

vagimeli added 2 - In progress Issue/PR: The issue or PR is in progress. v2.12.0 labels Dec 28, 2023

vagimeli self-assigned this Dec 28, 2023

vagimeli requested review from hdhalter, kolchfa-aws, Naarcha-AWS, AMoo-Miki and natebower as code owners December 28, 2023 00:25

vagimeli linked an issue Dec 28, 2023 that may be closed by this pull request

[DOC] New OSD Homepage #5530

Closed

4 tasks

vagimeli requested review from BSFishy and joshuarrrr December 28, 2023 00:27

vagimeli added 7 commits December 27, 2023 17:27

Merge branch 'main' into quickstart-redesign

44a0460

Update quickstart to include dashboards redesign

f3a712f

Signed-off-by: Melissa Vagi <[email protected]>

Update quickstart to include dashboards redesign

c957ec5

Signed-off-by: Melissa Vagi <[email protected]>

Update quickstart to include dashboards redesign

727c3ea

Signed-off-by: Melissa Vagi <[email protected]>

Updates to content and screenshots

2cfa321

Signed-off-by: Melissa Vagi <[email protected]>

Updates to content and screenshots

4a14b21

Signed-off-by: Melissa Vagi <[email protected]>

Merge branch 'main' into quickstart-redesign

45ca0bd

vagimeli added the 3 - Tech review PR: Tech review in progress label Jan 5, 2024

Merge branch 'main' into quickstart-redesign

8843561

kavilla reviewed Jan 9, 2024

View reviewed changes

vagimeli added 5 commits January 9, 2024 17:00

Copyedit

daa9d14

Signed-off-by: Melissa Vagi <[email protected]>

Merge branch 'main' into quickstart-redesign

cbed625

Merge branch 'main' into quickstart-redesign

7a5e749

Merge branch 'main' into quickstart-redesign

5e92eec

Merge branch 'main' into quickstart-redesign

07d0d9e

hdhalter removed the 2 - In progress Issue/PR: The issue or PR is in progress. label Jan 17, 2024

vagimeli mentioned this pull request Jan 22, 2024

[Meta] Preview Theme Next opensearch-project/OpenSearch-Dashboards#4675

Open

5 tasks

vagimeli and others added 4 commits February 27, 2024 13:55

Update _dashboards/quickstart.md

23a2770

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>

Update _dashboards/quickstart.md

ab83354

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>

Update _dashboards/quickstart.md

9da1940

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>

Update _dashboards/quickstart.md

f0ba91d

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>

vagimeli added 4 commits February 27, 2024 15:06

Update quickstart.md

102b155

Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>

Merge branch 'main' into quickstart-redesign

6428084

Address editorial feedback

66827d8

Signed-off-by: Melissa Vagi <[email protected]>

Revisions to incorporate quickstart editorial feedback

d438f88

Signed-off-by: Melissa Vagi <[email protected]>

natebower closed this Feb 28, 2024

natebower reopened this Feb 28, 2024

natebower approved these changes Feb 28, 2024

View reviewed changes

vagimeli added 3 commits February 28, 2024 08:51

add redirect

503c7d1

Signed-off-by: Melissa Vagi <[email protected]>

copy edit

1015d8d

Signed-off-by: Melissa Vagi <[email protected]>

copy edit

11e89d6

Signed-off-by: Melissa Vagi <[email protected]>

natebower reviewed Feb 29, 2024

View reviewed changes

vagimeli and others added 2 commits February 29, 2024 09:38

Update _dashboards/discover/index-discover.md

884baaa

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>

Update _dashboards/discover/index-discover.md

453b5a8

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>

vagimeli added 2 commits February 29, 2024 09:41

Address editorial review comments

e9d773f

Signed-off-by: Melissa Vagi <[email protected]>

Merge branch 'main' into quickstart-redesign

fc302bc

vagimeli added 3 - Done Issue is done/complete and removed 5 - Editorial review PR: Editorial review in progress labels Feb 29, 2024

vagimeli merged commit 7152f90 into main Feb 29, 2024
5 checks passed

vagimeli deleted the quickstart-redesign branch February 29, 2024 16:50

opensearch-trigger-bot bot mentioned this pull request Feb 29, 2024

[Backport 2.12] Update quickstart to include dashboards #6545

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update quickstart to include dashboards #6004

Update quickstart to include dashboards #6004

vagimeli commented Dec 28, 2023 •

edited

Loading

kavilla left a comment

kavilla Jan 9, 2024

vagimeli Jan 9, 2024 •

edited

Loading

BSFishy Jan 17, 2024

wbeckler Jan 29, 2024

vagimeli Jan 31, 2024

wbeckler Feb 1, 2024

wbeckler Feb 7, 2024

vagimeli Feb 13, 2024

vagimeli Feb 13, 2024

vagimeli commented Jan 24, 2024

vagimeli commented Feb 27, 2024

natebower commented Feb 28, 2024

natebower left a comment

natebower left a comment

natebower Feb 29, 2024

natebower Feb 29, 2024

vagimeli commented Feb 29, 2024


		- Install [OpenSearch Dashboards](https://opensearch.org/downloads.html).
		- Add sample data or import your own data into OpenSearch. Go to [OpenSearch Dashboards quickstart guide]({{site.url}}{{site.baseurl}}/dashboards/quickstart/) to learn about adding sample datasets. Go to [Managing indexes]({{site.url}}{{site.baseurl}}/im-plugin/index/) to learn about importing your own data.

Update quickstart to include dashboards #6004

Update quickstart to include dashboards #6004

Conversation

vagimeli commented Dec 28, 2023 • edited Loading

Description

Issues Resolved

Checklist

kavilla left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vagimeli Jan 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vagimeli commented Jan 24, 2024

vagimeli commented Feb 27, 2024

natebower commented Feb 28, 2024

natebower left a comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vagimeli commented Feb 29, 2024

vagimeli commented Dec 28, 2023 •

edited

Loading

vagimeli Jan 9, 2024 •

edited

Loading