[Doc] UI actions explorer #3614
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
Signed-off-by: Ashwin P Chandran <[email protected]>
Signed-off-by: Ashwin P Chandran <[email protected]>
Signed-off-by: Ashwin P Chandran <[email protected]>
Signed-off-by: Ashwin P Chandran <[email protected]>
Codecov Report
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more @@ Coverage Diff @@
## main #3614 +/- ##
==========================================
- Coverage 66.47% 66.46% -0.01%
==========================================
Files 3206 3206
Lines 61597 61599 +2
Branches 9503 9503
==========================================
- Hits 40945 40942 -3
- Misses 18380 18384 +4
- Partials 2272 2273 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 2 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
Signed-off-by: Ashwin P Chandran <[email protected]>
kavilla
approved these changes
Mar 16, 2023
zhongnansu
approved these changes
Mar 17, 2023
|
@zhongnansu Yeah this was something i did as a part of the visbuilder research. But i've added it to the PR for context :) |
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Mar 17, 2023
* adds ui actions explorer Signed-off-by: Ashwin P Chandran <[email protected]> * updates UI actions readme Signed-off-by: Ashwin P Chandran <[email protected]> * updates UI actions readme again Signed-off-by: Ashwin P Chandran <[email protected]> * cleans up developer examples view Signed-off-by: Ashwin P Chandran <[email protected]> * adds changelog Signed-off-by: Ashwin P Chandran <[email protected]> --------- Signed-off-by: Ashwin P Chandran <[email protected]> (cherry picked from commit c9211b9) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md
ananzh
reviewed
Mar 17, 2023
|
|
||
| ```ts | ||
| uiActions.attachAction(TRIGGER_ID, ACTION_ID); | ||
| ``` |
There was a problem hiding this comment.
NIT: Add one more sentence to explain why you need attach action to the registered trigger. For example: This will make your action available to be executed when the trigger event occurs.
ananzh
reviewed
Mar 17, 2023
| ```ts | ||
| uiActions.getTrigger(trigger.id).exec(context); | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I could add more explains here: This exec() method will iterate through all actions attached to this specific trigger and execute their execute methods defined in the actions.
abbyhu2000
pushed a commit
that referenced
this pull request
Mar 22, 2023
* adds ui actions explorer Signed-off-by: Ashwin P Chandran <[email protected]> * updates UI actions readme Signed-off-by: Ashwin P Chandran <[email protected]> * updates UI actions readme again Signed-off-by: Ashwin P Chandran <[email protected]> * cleans up developer examples view Signed-off-by: Ashwin P Chandran <[email protected]> * adds changelog Signed-off-by: Ashwin P Chandran <[email protected]> --------- Signed-off-by: Ashwin P Chandran <[email protected]> (cherry picked from commit c9211b9) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
pjfitzgibbons
pushed a commit
to pjfitzgibbons/OpenSearch-Dashboards
that referenced
this pull request
Mar 22, 2023
* adds ui actions explorer Signed-off-by: Ashwin P Chandran <[email protected]> * updates UI actions readme Signed-off-by: Ashwin P Chandran <[email protected]> * updates UI actions readme again Signed-off-by: Ashwin P Chandran <[email protected]> * cleans up developer examples view Signed-off-by: Ashwin P Chandran <[email protected]> * adds changelog Signed-off-by: Ashwin P Chandran <[email protected]> --------- Signed-off-by: Ashwin P Chandran <[email protected]>
sikhote
pushed a commit
to sikhote/OpenSearch-Dashboards
that referenced
this pull request
Apr 24, 2023
* adds ui actions explorer Signed-off-by: Ashwin P Chandran <[email protected]> * updates UI actions readme Signed-off-by: Ashwin P Chandran <[email protected]> * updates UI actions readme again Signed-off-by: Ashwin P Chandran <[email protected]> * cleans up developer examples view Signed-off-by: Ashwin P Chandran <[email protected]> * adds changelog Signed-off-by: Ashwin P Chandran <[email protected]> --------- Signed-off-by: Ashwin P Chandran <[email protected]> Signed-off-by: David Sinclair <[email protected]>
sikhote
pushed a commit
to sikhote/OpenSearch-Dashboards
that referenced
this pull request
Apr 24, 2023
* adds ui actions explorer Signed-off-by: Ashwin P Chandran <[email protected]> * updates UI actions readme Signed-off-by: Ashwin P Chandran <[email protected]> * updates UI actions readme again Signed-off-by: Ashwin P Chandran <[email protected]> * cleans up developer examples view Signed-off-by: Ashwin P Chandran <[email protected]> * adds changelog Signed-off-by: Ashwin P Chandran <[email protected]> --------- Signed-off-by: Ashwin P Chandran <[email protected]> Signed-off-by: David Sinclair <[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
UI Actions is a sparsely documented plugin like many of our other plugins. This PR aims to improve the docs for this plugin so that it is more accessible to plugin developers.
Adds UI Actions explorer
Adds docs for UI Actions
Cleaning up Developer Examples view
Issues Resolved
Check List
yarn test:jestyarn test:jest_integrationyarn test:ftr