-
Notifications
You must be signed in to change notification settings - Fork 892
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.
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
[Fix] Added documentation link for the dev tools' help menu #5166
Conversation
e320e1f
to
aebf549
Compare
@Willie-The-Lord Thanks for jumping on this really quickly. Looks like the original issue was misleading. The link it asked you to update is a global link and not specific to Dev Tools. To add a dev tools specific link you need to add a new one instead of modifying one. Here is an example of the Visualize app and how it adds such a link: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/visualize/public/application/utils/utils.ts#L37 And here is how it shows up on the app "Visualize" (The second Documentation link): Also be sure to add a changelog entry for your PR. |
Codecov Report
@@ Coverage Diff @@
## main #5166 +/- ##
=======================================
Coverage 66.77% 66.77%
=======================================
Files 3284 3284
Lines 63095 63095
Branches 10049 10049
=======================================
+ Hits 42132 42134 +2
+ Misses 18489 18488 -1
+ Partials 2474 2473 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Also need a CHANGELOG. You could find the CHANGELOG.md file and see many references. |
Hi @ashwin-pc I've added the new documentation link to the dev tool help menu. I've looked up other plugins (Visualize & Dashboards) and found out the function |
I found out that I've signed off other commits that doesn't belongs to me. How can I reverse that? |
764d56d
to
c5d5e45
Compare
@Willie-The-Lord you latest commit did not have a signoff thats tripping the DCO checker. Can you follow the instruction in the DCO workflow to fix it? |
5a1851f
to
216e530
Compare
src/dev/build/tasks/os_packages/create_os_package_tasks.test.ts
Outdated
Show resolved
Hide resolved
Hi @ashwin-pc, I ran |
You probably want to push all of them. But you can also check the prior workflow to see which previous failures needed to be fixed. |
Signed-off-by: Willie Hung <willie880201044@gmail.com>
Signed-off-by: Willie Hung <willie880201044@gmail.com>
Signed-off-by: Willie Hung <willie880201044@gmail.com>
Signed-off-by: Willie Hung <willie880201044@gmail.com>
Signed-off-by: Willie Hung <willie880201044@gmail.com>
Signed-off-by: Willie Hung <willie880201044@gmail.com>
Hi @joshuarrrr @ashwin-pc , I've pushed the new snapshots. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! LGTM :)
Thanks @ashwin-pc ! It seems like all the test cases passed. |
* Add documentation link to dev tool's help menu Signed-off-by: Willie Hung <willie880201044@gmail.com> * Add CHANGELOG Signed-off-by: Willie Hung <willie880201044@gmail.com> * Edit CHANGELOG message Signed-off-by: Willie Hung <willie880201044@gmail.com> * Edit CHANGELOG message Signed-off-by: Willie Hung <willie880201044@gmail.com> * Changed new file copyright license Signed-off-by: Willie Hung <willie880201044@gmail.com> * Update new snapshots Signed-off-by: Willie Hung <willie880201044@gmail.com> --------- Signed-off-by: Willie Hung <willie880201044@gmail.com> Co-authored-by: Ashwin P Chandran <ashwinpc@amazon.com> (cherry picked from commit 60f4c8f) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md
* Add documentation link to dev tool's help menu Signed-off-by: Willie Hung <willie880201044@gmail.com> * Add CHANGELOG Signed-off-by: Willie Hung <willie880201044@gmail.com> * Edit CHANGELOG message Signed-off-by: Willie Hung <willie880201044@gmail.com> * Edit CHANGELOG message Signed-off-by: Willie Hung <willie880201044@gmail.com> * Changed new file copyright license Signed-off-by: Willie Hung <willie880201044@gmail.com> * Update new snapshots Signed-off-by: Willie Hung <willie880201044@gmail.com> --------- Signed-off-by: Willie Hung <willie880201044@gmail.com> Co-authored-by: Ashwin P Chandran <ashwinpc@amazon.com> (cherry picked from commit 60f4c8f) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md
…5302) * Add documentation link to dev tool's help menu Signed-off-by: Willie Hung <willie880201044@gmail.com> * Add CHANGELOG Signed-off-by: Willie Hung <willie880201044@gmail.com> * Edit CHANGELOG message Signed-off-by: Willie Hung <willie880201044@gmail.com> * Edit CHANGELOG message Signed-off-by: Willie Hung <willie880201044@gmail.com> * Changed new file copyright license Signed-off-by: Willie Hung <willie880201044@gmail.com> * Update new snapshots Signed-off-by: Willie Hung <willie880201044@gmail.com> --------- Signed-off-by: Willie Hung <willie880201044@gmail.com> Co-authored-by: Ashwin P Chandran <ashwinpc@amazon.com> (cherry picked from commit 60f4c8f) 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>
Description
Added Help Menu extension (dev tool documentation link - https://opensearch.org/docs/latest/dashboards/dev-tools/index-dev/) to dev tool plugin's help menu.
Issues Resolved
Added dev tool's documentation link to the dev tools' help menu
closes #4645
Screenshot
The documentation link appears correctly in my local environment.
Testing the changes
Check List
yarn test:jest
yarn test:jest_integration
yarn test:ftr