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.

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

Merged
merged 9 commits into from
Oct 14, 2023

Conversation

willie-hung
Copy link
Contributor

@willie-hung willie-hung commented Oct 1, 2023

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.

  • Before
    Screenshot 2023-10-11 at 12 17 02 PM
  • After
    Screenshot 2023-10-11 at 12 18 10 PM

Testing the changes

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
Copy link
Member

ashwin-pc commented Oct 2, 2023

@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):
Screenshot 2023-10-02 at 2 47 40 AM

Also be sure to add a changelog entry for your PR.

@codecov
Copy link

codecov bot commented Oct 2, 2023

Codecov Report

Merging #5166 (c89b792) into main (7a964b6) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           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     
Flag Coverage Δ
Linux_1 35.26% <ø> (ø)
Linux_2 55.24% <ø> (ø)
Linux_3 43.85% <ø> (+<0.01%) ⬆️
Linux_4 35.36% <ø> (ø)
Windows_1 35.27% <ø> (ø)
Windows_2 55.20% <ø> (ø)
Windows_3 43.85% <ø> (ø)
Windows_4 35.36% <ø> (ø)

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

Files Coverage Δ
src/core/public/doc_links/doc_links_service.ts 100.00% <ø> (ø)

... and 1 file with indirect coverage changes

@ananzh
Copy link
Member

ananzh commented Oct 3, 2023

Also need a CHANGELOG. You could find the CHANGELOG.md file and see many references.

@willie-hung
Copy link
Contributor Author

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 addHelpMenuToAppChrome is placed in an util folder. Hence I created one in the dev tool plugin too. Not really sure whether it is the best practice. Thanks!

@willie-hung
Copy link
Contributor Author

I found out that I've signed off other commits that doesn't belongs to me. How can I reverse that?

@willie-hung willie-hung changed the title Fixes the wrong documentation link for the dev tools' help menu [Fix] Fixes the wrong documentation link for the dev tools' help menu Oct 6, 2023
@willie-hung willie-hung reopened this Oct 11, 2023
@ashwin-pc
Copy link
Member

@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?

@willie-hung
Copy link
Contributor Author

Hi @ashwin-pc, I ran yarn test:jest -u locally, and it modified several files in the process. Now, I'm unsure which files I need to push to the remote repository. Any guidance on this would be greatly appreciated!

@joshuarrrr
Copy link
Member

Hi @ashwin-pc, I ran yarn test:jest -u locally, and it modified several files in the process. Now, I'm unsure which files I need to push to the remote repository. Any guidance on this would be greatly appreciated!

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>
@willie-hung
Copy link
Contributor Author

Hi @joshuarrrr @ashwin-pc , I've pushed the new snapshots.

Copy link
Member

@ashwin-pc ashwin-pc left a comment

Choose a reason for hiding this comment

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

Nice! LGTM :)

@willie-hung
Copy link
Contributor Author

Thanks @ashwin-pc ! It seems like all the test cases passed.

@joshuarrrr joshuarrrr merged commit 60f4c8f into opensearch-project:main Oct 14, 2023
128 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 14, 2023
* 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
manasvinibs pushed a commit that referenced this pull request Oct 26, 2023
* 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
joshuarrrr pushed a commit that referenced this pull request Nov 7, 2023
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Update Dev Tools Documentation link under help in console
5 participants