Add documentation for dashboards assistant plugin #6370

ruanyl · 2024-02-08T06:38:24Z

Description

Documentation for dashboards assistant plugin.

The documentation is created by @xluo-aws @wanglam @gaobinlong @raintygao @ruanyl

Issues Resolved

Closes #6369

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: Yulong Ruan <ruanyl@amazon.com>

kgcreative · 2024-02-08T21:45:30Z

This should be "OpenSearch Assistant Toolkit for OpenSearch Dashboards" (if we are specifically referring to the OpenSearch Dashboards features, as opposed to "OpenSearch Assistant Toolkit" for all the backend tooling)

vagimeli

@ruanyl Please review my edits and comments. Please make sure my edits have retained technical accuracy. Once you approves the changes, I'll format the file and replace any low-resolution screenshots. Please provide the testing environment. Following this, I'll schedule the doc for editorial review. Please be available to answer any technical questions. Thank you, Melissa

cc: @nitincd @kgcreative for input
cc: @kolchfa-aws for doc website structure

_dashboards-assistant/index.md

vagimeli · 2024-02-09T18:49:06Z

This should be "OpenSearch Assistant Toolkit for OpenSearch Dashboards" (if we are specifically referring to the OpenSearch Dashboards features, as opposed to "OpenSearch Assistant Toolkit" for all the backend tooling)

@kgcreative I agree. I've changed doc title.

vagimeli · 2024-02-13T18:55:27Z

@xluo-aws @wanglam @gaobinlong @raintygao @ruanyl

To move this documentation forward, please provide your technical review and approval. Once I have your approval of my rewrites and edits, I can move the content into editorial review and then merge the PR. Please reach out to me with any questions. Thank you.

_dashboards-assistant/index.md

ylwu-amzn · 2024-02-15T00:31:05Z

@ruanyl looks some screenshot should be updated

lezzago · 2024-02-15T00:42:26Z

_dashboards-assistant/index.md

+<img width="600px" src="{{site.url}}{{site.baseurl}}/images/dashboards-assistant/suggestions.png" alt="The assistant suggestions">
+
+### Rate the response
+Each response contains a thumb up and thumb down icon button, you can click on the button to feedback whether you are satisfied with the response.


We should add a little tidbit on where this feedback is stored, so users won't have concerns that the data is not being transmitted anywhere?

xluo-aws · 2024-02-15T01:00:48Z

Will update the doc by next Monday if that's ok. All related team members are taking holidays off this week.

raintygao · 2024-02-15T08:36:19Z

Will update the doc by next Monday if that's ok. All related team members are taking holidays off this week.

@xluo-aws According to release issue, pre release is on the end of February 19th. If there are any updates needed we can complete them before end of 18th, not sure if it's OK.

raintygao · 2024-02-15T08:46:53Z

@ruanyl looks some screenshot should be updated

@ylwu-amzn Could you elaborate more?

Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Yulong Ruan <ruanyu1@gmail.com>

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

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

ylwu-amzn · 2024-02-16T21:10:46Z

@ruanyl looks some screenshot should be updated

@ylwu-amzn Could you elaborate more?

Shared you a latest test cluster. You can take new screenshots there.

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

vagimeli · 2024-02-19T18:16:43Z

@ruanyl looks some screenshot should be updated

@ylwu-amzn Could you elaborate more?

Shared you a latest test cluster. You can take new screenshots there.

@ylwu-amzn @ruanyl I've replaced screenshots based on the the test environment you shared. Please provide your approval of this PR if its ready for merging. Thank you, Melissa

vagimeli · 2024-02-19T18:18:19Z

_dashboards/dashboards-assistant/index.md

+```
+{% include copy-curl.html %}
+
+This example is a system index. In security-enabled domains, only super administrators have access to execute this code. For details about making super admin calls, see the [System indexes]({{site.url}}{{site.baseurl}}/security/configuration/system-indices/) guide. For access permission, contact your IT administrator.


@natebower Please edit lines 43-44.

natebower

@vagimeli Line 43 edited.

_dashboards/dashboards-assistant/index.md

natebower · 2024-02-19T18:25:49Z

_dashboards/dashboards-assistant/index.md

+```
+{% include copy-curl.html %}
+
+This example is a system index. In security-enabled domains, only super administrators have access to execute this code. For details about making super admin calls, see the [System indexes]({{site.url}}{{site.baseurl}}/security/configuration/system-indices/) guide. For access permission, contact your IT administrator.


This example shows/provides/uses a system index? (The example isn't literally a system index). Also, I believe I may have seen "superadmin" used elsewhere. I would confirm what we've used elsewhere and make consistent here.

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

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

vagimeli

Doc and editorial reviews completed. Editorial feedback addressed.

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

…#6370) * Add documentation for dashboards assistant plugin --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Signed-off-by: Yulong Ruan <ruanyu1@gmail.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>

Add documentation for dashboards assistant plugin

4d49e10

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

ruanyl requested review from hdhalter, kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower and dlvenable as code owners February 8, 2024 06:38

Merge branch 'main' into dashboards-assistant-documentation

cf69285

hdhalter assigned vagimeli Feb 8, 2024

hdhalter added release-notes PR: Include this PR in the automated release notes v2.12.0 4 - Doc Review PR: Doc review in progress labels Feb 8, 2024

vagimeli reviewed Feb 9, 2024

View reviewed changes

Merge branch 'main' into dashboards-assistant-documentation

710bf78

Merge branch 'main' into dashboards-assistant-documentation

476c114

vagimeli added 3 - Tech Review PR: Tech review in progress and removed 4 - Doc Review PR: Doc review in progress labels Feb 13, 2024

Merge branch 'main' into dashboards-assistant-documentation

f611630

vagimeli reviewed Feb 14, 2024

View reviewed changes

_dashboards-assistant/index.md Outdated Show resolved Hide resolved

lezzago reviewed Feb 15, 2024

View reviewed changes

ruanyl and others added 2 commits February 15, 2024 19:29

Update _dashboards-assistant/index.md

0318da7

Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Yulong Ruan <ruanyu1@gmail.com>

Update _dashboards-assistant/index.md

481c41b

Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Yulong Ruan <ruanyu1@gmail.com>

vagimeli and others added 5 commits February 15, 2024 16:19

Merge branch 'main' into dashboards-assistant-documentation

e85c6ed

Update index.md

e4f15af

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

Update index.md

2e9fd47

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

add information about where the message feedback is stored

9da0037

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

update screenshots

b1c79a8

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

natebower added 6 - Done but waiting to merge PR: The work is done and ready to merge and removed 5 - Final Editorial Review PR: Editorial Review in progress labels Feb 16, 2024

Merge branch 'main' into dashboards-assistant-documentation

a7e1f86

vagimeli added 5 commits February 16, 2024 16:30

Update screenshots and copy edits

d71243d

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

Update screenshots and copy edits

55a711f

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

Update screenshots and copy edits

aead29a

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

Merge branch 'main' into dashboards-assistant-documentation

788dad2

Address editorial review comments and replace screenshots

1093c20

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

vagimeli reviewed Feb 19, 2024

View reviewed changes

natebower reviewed Feb 19, 2024

View reviewed changes

vagimeli and others added 6 commits February 19, 2024 11:32

Update _dashboards/dashboards-assistant/index.md

26d5ee5

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update index.md

930c0fa

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

Merge branch 'main' into dashboards-assistant-documentation

364dde2

Update index.md

72db10f

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

Update index.md

9ff635b

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

Merge branch 'main' into dashboards-assistant-documentation

0b946fd

vagimeli approved these changes Feb 19, 2024

View reviewed changes

Update index.md

8f9bd61

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

vagimeli added 3 - Done Issue is done/complete and removed 6 - Done but waiting to merge PR: The work is done and ready to merge labels Feb 19, 2024

vagimeli merged commit f730f7d into opensearch-project:main Feb 19, 2024
3 of 4 checks passed

kolchfa-aws added the experimental label Feb 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for dashboards assistant plugin #6370

Add documentation for dashboards assistant plugin #6370

ruanyl commented Feb 8, 2024 •

edited by hdhalter

Loading

kgcreative commented Feb 8, 2024

vagimeli left a comment •

edited

Loading

vagimeli commented Feb 9, 2024

vagimeli commented Feb 13, 2024

ylwu-amzn commented Feb 15, 2024

lezzago Feb 15, 2024

xluo-aws commented Feb 15, 2024

raintygao commented Feb 15, 2024 •

edited

Loading

raintygao commented Feb 15, 2024

ylwu-amzn commented Feb 16, 2024

vagimeli commented Feb 19, 2024

vagimeli Feb 19, 2024

natebower left a comment

natebower Feb 19, 2024

vagimeli left a comment

Add documentation for dashboards assistant plugin #6370

Add documentation for dashboards assistant plugin #6370

Conversation

ruanyl commented Feb 8, 2024 • edited by hdhalter Loading

Description

Issues Resolved

Checklist

kgcreative commented Feb 8, 2024

vagimeli left a comment • edited Loading

Choose a reason for hiding this comment

vagimeli commented Feb 9, 2024

vagimeli commented Feb 13, 2024

ylwu-amzn commented Feb 15, 2024

lezzago Feb 15, 2024

Choose a reason for hiding this comment

xluo-aws commented Feb 15, 2024

raintygao commented Feb 15, 2024 • edited Loading

raintygao commented Feb 15, 2024

ylwu-amzn commented Feb 16, 2024

vagimeli commented Feb 19, 2024

vagimeli Feb 19, 2024

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

natebower Feb 19, 2024

Choose a reason for hiding this comment

vagimeli left a comment

Choose a reason for hiding this comment

ruanyl commented Feb 8, 2024 •

edited by hdhalter

Loading

vagimeli left a comment •

edited

Loading

raintygao commented Feb 15, 2024 •

edited

Loading