UBI docs consolidation #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
epugh
reviewed
May 22, 2024
_search-plugins/ubi/documentation.md
Outdated
|
|
||
| ## Quick Start | ||
|
|
||
| Build the plugin. Note that you will have to match up the JDK 11 on your system to java home in the `gradle.properties` file: |
There was a problem hiding this comment.
I think the build stuff should move somewhere else, as most folks won't build the code.. it'll look more like waht you see at https://opensearch.org/docs/latest/search-plugins/querqy/index/#querqy-plugin-installation
_search-plugins/ubi/documentation.md
Outdated
|
|
||
| Build the OpenSearch docker image and add the plugin, then start the containers: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
this feels like ti should be in it's own deep dive? NOt totally sure...
…mentation-website into ubi-docs-consolidation
epugh
pushed a commit
that referenced
this pull request
Nov 23, 2024
* doc: add document for dashboards assistant text to visualization Signed-off-by: Yulong Ruan <[email protected]> * Add documentation for suggest anomaly detector feature (#1) Signed-off-by: gaobinlong <[email protected]> * doc: Add document for dashboard assistant alert insight (opensearch-project#2) * doc: Add document for dashboard assistant alert insight * fix title Signed-off-by: qianheng <[email protected]> * Add data summary documentation (opensearch-project#3) Signed-off-by: Liyun Xiu <[email protected]> * add doc for alert insight agent (opensearch-project#4) * add doc for alert insight agent Signed-off-by: yuye-aws <[email protected]> * add example request for alert insight API Signed-off-by: yuye-aws <[email protected]> * correct default value for question parameter for alert insight API Signed-off-by: yuye-aws <[email protected]> * add pics for alert insight UI Signed-off-by: yuye-aws <[email protected]> --------- Signed-off-by: yuye-aws <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * minor rewording Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Change to data summary feature Signed-off-by: Fanit Kolchina <[email protected]> * add instruction on how to create t2viz agents with flow template Signed-off-by: Yulong Ruan <[email protected]> * fix doc for alert summary and insight (opensearch-project#5) * fix doc for alert summary and insight Signed-off-by: yuye-aws <[email protected]> * fix doc Signed-off-by: yuye-aws <[email protected]> * change main branch to 2.x branch Signed-off-by: yuye-aws <[email protected]> * small fix Signed-off-by: yuye-aws <[email protected]> --------- Signed-off-by: yuye-aws <[email protected]> * Rewording agent creation steps Signed-off-by: Fanit Kolchina <[email protected]> * Editorial comment and rewording Signed-off-by: Fanit Kolchina <[email protected]> * Image sizes Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Yulong Ruan <[email protected]> Signed-off-by: gaobinlong <[email protected]> Signed-off-by: qianheng <[email protected]> Signed-off-by: Liyun Xiu <[email protected]> Signed-off-by: yuye-aws <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: gaobinlong <[email protected]> Co-authored-by: qianheng <[email protected]> Co-authored-by: Liyun Xiu <[email protected]> Co-authored-by: yuye-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
epugh
pushed a commit
that referenced
this pull request
Nov 23, 2024
* doc: add document for dashboards assistant text to visualization Signed-off-by: Yulong Ruan <[email protected]> * Add documentation for suggest anomaly detector feature (#1) Signed-off-by: gaobinlong <[email protected]> * doc: Add document for dashboard assistant alert insight (opensearch-project#2) * doc: Add document for dashboard assistant alert insight * fix title Signed-off-by: qianheng <[email protected]> * Add data summary documentation (opensearch-project#3) Signed-off-by: Liyun Xiu <[email protected]> * add doc for alert insight agent (opensearch-project#4) * add doc for alert insight agent Signed-off-by: yuye-aws <[email protected]> * add example request for alert insight API Signed-off-by: yuye-aws <[email protected]> * correct default value for question parameter for alert insight API Signed-off-by: yuye-aws <[email protected]> * add pics for alert insight UI Signed-off-by: yuye-aws <[email protected]> --------- Signed-off-by: yuye-aws <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * minor rewording Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Change to data summary feature Signed-off-by: Fanit Kolchina <[email protected]> * add instruction on how to create t2viz agents with flow template Signed-off-by: Yulong Ruan <[email protected]> * fix doc for alert summary and insight (opensearch-project#5) * fix doc for alert summary and insight Signed-off-by: yuye-aws <[email protected]> * fix doc Signed-off-by: yuye-aws <[email protected]> * change main branch to 2.x branch Signed-off-by: yuye-aws <[email protected]> * small fix Signed-off-by: yuye-aws <[email protected]> --------- Signed-off-by: yuye-aws <[email protected]> * Rewording agent creation steps Signed-off-by: Fanit Kolchina <[email protected]> * Editorial comment and rewording Signed-off-by: Fanit Kolchina <[email protected]> * Image sizes Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Yulong Ruan <[email protected]> Signed-off-by: gaobinlong <[email protected]> Signed-off-by: qianheng <[email protected]> Signed-off-by: Liyun Xiu <[email protected]> Signed-off-by: yuye-aws <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: gaobinlong <[email protected]> Co-authored-by: qianheng <[email protected]> Co-authored-by: Liyun Xiu <[email protected]> Co-authored-by: yuye-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Eric Pugh <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adding content for User Behavior Insights
Issues Resolved
This documents different features for Ubi
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.