Skip to content

add doc for alert insight agent#4

Merged
ruanyl merged 4 commits intoruanyl:add-dashboards-assistant-docfrom
yuye-aws:add-dashboards-assistant-doc
Nov 1, 2024
Merged

add doc for alert insight agent#4
ruanyl merged 4 commits intoruanyl:add-dashboards-assistant-docfrom
yuye-aws:add-dashboards-assistant-doc

Conversation

@yuye-aws
Copy link

@yuye-aws yuye-aws commented Oct 31, 2024

Description

Add doc for alert insight agent

Issues Resolved

Add doc for alert insight agent

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: yuye-aws <yuyezhu@amazon.com>
@github-actions
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Copy link

@qianheng-aws qianheng-aws left a comment

Choose a reason for hiding this comment

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

Need to add verification on insight API as well. You can see its API definition here: https://github.com/opensearch-project/dashboards-assistant/blob/50fef5c06993b110367314400f857042ef646568/server/routes/summary_routes.ts#L83, and write related test like summary API.

Signed-off-by: yuye-aws <yuyezhu@amazon.com>
Signed-off-by: yuye-aws <yuyezhu@amazon.com>
@yuye-aws
Copy link
Author

yuye-aws commented Nov 1, 2024

Need to add verification on insight API as well. You can see its API definition here: https://github.com/opensearch-project/dashboards-assistant/blob/50fef5c06993b110367314400f857042ef646568/server/routes/summary_routes.ts#L83, and write related test like summary API.

Ack. Updated.

@yuye-aws yuye-aws requested a review from qianheng-aws November 1, 2024 04:13
Signed-off-by: yuye-aws <yuyezhu@amazon.com>
@yuye-aws
Copy link
Author

yuye-aws commented Nov 1, 2024

Pinging @ruanyl for CI check and merge.

@ruanyl ruanyl merged commit b07cb5e into ruanyl:add-dashboards-assistant-doc Nov 1, 2024
ruanyl pushed a commit that referenced this pull request Nov 1, 2024
* add doc for alert insight agent

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

* add example request for alert insight API

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

* correct default value for question parameter for alert insight API

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

* add pics for alert insight UI

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

---------

Signed-off-by: yuye-aws <yuyezhu@amazon.com>
ruanyl pushed a commit that referenced this pull request Nov 1, 2024
* add doc for alert insight agent

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

* add example request for alert insight API

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

* correct default value for question parameter for alert insight API

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

* add pics for alert insight UI

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

---------

Signed-off-by: yuye-aws <yuyezhu@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants