Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Doc] UI actions explorer #3614

Merged
merged 5 commits into from
Mar 17, 2023
Merged

[Doc] UI actions explorer #3614

merged 5 commits into from
Mar 17, 2023

Conversation

ashwin-pc
Copy link
Member

@ashwin-pc ashwin-pc commented Mar 15, 2023 •
edited

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
    Screenshot 2023-03-15 at 3 43 21 PM

  • Adds docs for UI Actions

  • Cleaning up Developer Examples view
    Screenshot 2023-03-15 at 3 44 34 PM

Issues Resolved

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
    • yarn test:ftr
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

@ashwin-pc
adds ui actions explorer
310a265 
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
@ashwin-pc
updates UI actions readme
3d5cdd9 
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
@ashwin-pc
updates UI actions readme again
a4868e8 
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
@ashwin-pc
cleans up developer examples view
8a18e3a 
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
@ashwin-pc ashwin-pc requested a review from a team as a code owner March 15, 2023 22:45
@ashwin-pc ashwin-pc self-assigned this Mar 15, 2023
@codecov-commenter
Copy link

Codecov Report

Merging #3614 (8a18e3a) into main (7b18e06) will decrease coverage by 0.01%.
The diff coverage is 50.00%.

📣 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
Flag Coverage Δ
Linux 66.41% <50.00%> (-0.01%) ⬇️
Windows 66.41% <50.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...ns/ui_actions/public/service/ui_actions_service.ts 85.36% <50.00%> (-0.89%) ⬇️

... 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.

@ashwin-pc ashwin-pc changed the title UI actions explorer [Doc] UI actions explorer Mar 16, 2023
@ashwin-pc
adds changelog
5f6c86a 
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
zhongnansu
zhongnansu approved these changes Mar 17, 2023
View reviewed changes
Copy link
Member

@zhongnansu zhongnansu left a comment

Choose a reason for hiding this comment

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

I don't see an issue attached to this PR, is it because it's a doc change? and an issue is optional? Overall LGTM

@ashwin-pc
Copy link
Member Author

@zhongnansu Yeah this was something i did as a part of the visbuilder research. But i've added it to the PR for context :)

@ashwin-pc ashwin-pc merged commit c9211b9 into opensearch-project:main Mar 17, 2023
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Mar 17, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 17, 2023
@github-actions
[Doc] UI actions explorer (#3614)
dd91cfd 
* adds ui actions explorer

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* updates UI actions readme

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* updates UI actions readme again

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* cleans up developer examples view

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* adds changelog

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

---------

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
(cherry picked from commit c9211b9)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md
ananzh
ananzh reviewed Mar 17, 2023
View reviewed changes
src/plugins/ui_actions/README.md

```ts
uiActions.attachAction(TRIGGER_ID, ACTION_ID);
```
Copy link
Member

Choose a reason for hiding this comment

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

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
ananzh reviewed Mar 17, 2023
View reviewed changes
src/plugins/ui_actions/README.md
```ts
uiActions.getTrigger(trigger.id).exec(context);
```

Copy link
Member

Choose a reason for hiding this comment

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

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
@opensearch-trigger-bot @github-actions
[Doc] UI actions explorer (#3614) (#3630)
b4fa703 
* adds ui actions explorer

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* updates UI actions readme

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* updates UI actions readme again

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* cleans up developer examples view

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* adds changelog

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

---------

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
(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
@ashwin-pc
[Doc] UI actions explorer (opensearch-project#3614)
ea9d367 
* adds ui actions explorer

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* updates UI actions readme

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* updates UI actions readme again

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* cleans up developer examples view

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* adds changelog

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

---------

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
@ashwin-pc ashwin-pc added the docs Improvements or additions to documentation label Apr 11, 2023
sikhote pushed a commit to sikhote/OpenSearch-Dashboards that referenced this pull request Apr 24, 2023
@ashwin-pc @sikhote
[Doc] UI actions explorer (opensearch-project#3614)
b867d2f 
* adds ui actions explorer

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* updates UI actions readme

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* updates UI actions readme again

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* cleans up developer examples view

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* adds changelog

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

---------

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
Signed-off-by: David Sinclair <david@sinclair.tech>
sikhote pushed a commit to sikhote/OpenSearch-Dashboards that referenced this pull request Apr 24, 2023
@ashwin-pc @sikhote
[Doc] UI actions explorer (opensearch-project#3614)
e654cdf 
* adds ui actions explorer

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* updates UI actions readme

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* updates UI actions readme again

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* cleans up developer examples view

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* adds changelog

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

---------

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
Signed-off-by: David Sinclair <david@sinclair.tech>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ananzh ananzh ananzh left review comments

@kavilla kavilla kavilla approved these changes

@zhongnansu zhongnansu zhongnansu approved these changes

Assignees

@ashwin-pc ashwin-pc

Labels
backport 2.x docs Improvements or additions to documentation v2.7.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@ashwin-pc @codecov-commenter @kavilla @zhongnansu @ananzh