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

[CCI] Adding second command to Install yarn step in Developer Guide #3633

Merged
merged 7 commits into from
Mar 22, 2023
Merged

[CCI] Adding second command to Install yarn step in Developer Guide #3633

merged 7 commits into from
Mar 22, 2023

Conversation

kappassov
Copy link
Contributor

@kappassov kappassov commented Mar 19, 2023 •
edited
Loading

Description

Currently, Developer Guide has only one command listed in yarn installation step: npm i -g corepack . Writing only this one command seems to be incomplete and might be confusing for newcomers. Moreover, current description requires making extra step by going to the official installation docs without even trying Developer Guide's instructions.

Issues Resolved

Adding the following command corepack prepare yarn@<version> --activate to the yarn installation paragraph will fulfill all minimum required steps to install yarn, and might help to avoid extra visiting yarn documentation.

Screenshot_20230319_212213

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

@kappassov kappassov requested a review from a team as a code owner March 19, 2023 15:25
@kappassov kappassov changed the title Adding second command to Install yarn step in Developer Guide [CCI] Adding second command to Install yarn step in Developer Guide Mar 19, 2023
@kappassov
added prepare command
ea40110 
Signed-off-by: kappassov <[email protected]>
joshuarrrr
joshuarrrr reviewed Mar 21, 2023
View reviewed changes
Copy link
Member

@joshuarrrr joshuarrrr left a comment

Choose a reason for hiding this comment

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

Excellent find, thanks!

If we're going to add that, I think we also want to include the link to the yarn version. One other small nit - otherwise looks great!

DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
@joshuarrrr joshuarrrr self-assigned this Mar 21, 2023
@joshuarrrr joshuarrrr added the OSCI Open Source Contributor Initiative label Mar 21, 2023
ananzh and others added 6 commits March 21, 2023 12:18
@ananzh @kappassov
Use mirrors to download Node.js binaries to escape sporadic 404 errors (
59be6b4 
opensearch-project#3619)

Issue Resolved:
opensearch-project#3618

Signed-off-by: Anan Zhuang <[email protected]>
@AMoo-Miki @kappassov
Allow selecting the Node.js binary OSD uses (opensearch-project#3508)
0a8b9e1 
New reusable use_node scripts take care of selecting the correct Node.js binary based OSD_NODE_HOME, OSD_HOME, and whatever is in the PATH. It also takes care of finding the binary on FreeBSD.
* The startup scripts check `OSD_NODE_HOME` and `NODE_HOME` before falling back to use the bundled or system-wide Node.js binary.
* Update `package.json` to replace `node` with `use_node`.
* Update file templates and shell scripts to internally use `use_node`.
* Update the build scripts to copy `use_node` into releases
* Make tests that execute node internally, honor the binary being used.

Signed-off-by: Miki <[email protected]>
@AMoo-Miki @kappassov
Clean up and rebuild @osd/pm (opensearch-project#3570)
95a0b24 
* Fix the build failures
* Removed some unused packages
* Update gist url templates in Lychee's exclusion list

Signed-off-by: Miki <[email protected]>
@zhongnansu @kappassov
Refactor dev tool console to use opensearch-js client to send request (…
1d94df4 
…opensearch-project#3544)

Refactor dev tool console to use opensearch-js client to interact with OpenSearch

Signed-off-by: Su <[email protected]>
@kappassov
updates after the 1st review
977d653 
Signed-off-by: kappassov <[email protected]>
@kappassov
Merge branch 'opensearch-project:main' into developer-guide-addition
f9a624e
@joshuarrrr
Copy link
Member

I set DCO to pass, as it was a false positive from a rebase commit.

@joshuarrrr joshuarrrr added the Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry label Mar 22, 2023
abbyhu2000
abbyhu2000 approved these changes Mar 22, 2023
View reviewed changes
Copy link
Member

@abbyhu2000 abbyhu2000 left a comment

Choose a reason for hiding this comment

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

This LGTM, thanks!

@abbyhu2000 abbyhu2000 merged commit b0146e7 into opensearch-project:main Mar 22, 2023
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Mar 22, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 22, 2023
@github-actions @ananzh
@AMoo-Miki @zhongnansu
[CCI] Adding second command to Install yarn step in Developer Guide (#…
a91302d 
…3633)

* added prepare command

Signed-off-by: kappassov <[email protected]>

* Use mirrors to download Node.js binaries to escape sporadic 404 errors (#3619)

Issue Resolved:
#3618

Signed-off-by: Anan Zhuang <[email protected]>

* Allow selecting the Node.js binary OSD uses (#3508)

New reusable use_node scripts take care of selecting the correct Node.js binary based OSD_NODE_HOME, OSD_HOME, and whatever is in the PATH. It also takes care of finding the binary on FreeBSD.
* The startup scripts check `OSD_NODE_HOME` and `NODE_HOME` before falling back to use the bundled or system-wide Node.js binary.
* Update `package.json` to replace `node` with `use_node`.
* Update file templates and shell scripts to internally use `use_node`.
* Update the build scripts to copy `use_node` into releases
* Make tests that execute node internally, honor the binary being used.

Signed-off-by: Miki <[email protected]>

* Clean up and rebuild @osd/pm (#3570)

* Fix the build failures
* Removed some unused packages
* Update gist url templates in Lychee's exclusion list

Signed-off-by: Miki <[email protected]>

* Refactor dev tool console to use opensearch-js client to send request (#3544)

Refactor dev tool console to use opensearch-js client to interact with OpenSearch

Signed-off-by: Su <[email protected]>

* updates after the 1st review

Signed-off-by: kappassov <[email protected]>

---------

Signed-off-by: kappassov <[email protected]>
Signed-off-by: Anan Zhuang <[email protected]>
Signed-off-by: Miki <[email protected]>
Signed-off-by: Su <[email protected]>
Co-authored-by: Anan Zhuang <[email protected]>
Co-authored-by: Miki <[email protected]>
Co-authored-by: Zhongnan Su <[email protected]>
(cherry picked from commit b0146e7)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
abbyhu2000 pushed a commit that referenced this pull request Mar 22, 2023
@opensearch-trigger-bot @github-actions
@ananzh @AMoo-Miki @zhongnansu
[CCI] Adding second command to Install yarn step in Developer Guide (#…
3d2082a 
…3633) (#3651)

* added prepare command



* Use mirrors to download Node.js binaries to escape sporadic 404 errors (#3619)

Issue Resolved:
#3618



* Allow selecting the Node.js binary OSD uses (#3508)

New reusable use_node scripts take care of selecting the correct Node.js binary based OSD_NODE_HOME, OSD_HOME, and whatever is in the PATH. It also takes care of finding the binary on FreeBSD.
* The startup scripts check `OSD_NODE_HOME` and `NODE_HOME` before falling back to use the bundled or system-wide Node.js binary.
* Update `package.json` to replace `node` with `use_node`.
* Update file templates and shell scripts to internally use `use_node`.
* Update the build scripts to copy `use_node` into releases
* Make tests that execute node internally, honor the binary being used.



* Clean up and rebuild @osd/pm (#3570)

* Fix the build failures
* Removed some unused packages
* Update gist url templates in Lychee's exclusion list



* Refactor dev tool console to use opensearch-js client to send request (#3544)

Refactor dev tool console to use opensearch-js client to interact with OpenSearch



* updates after the 1st review



---------








(cherry picked from commit b0146e7)

Signed-off-by: kappassov <[email protected]>
Signed-off-by: Anan Zhuang <[email protected]>
Signed-off-by: Miki <[email protected]>
Signed-off-by: Su <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Anan Zhuang <[email protected]>
Co-authored-by: Miki <[email protected]>
Co-authored-by: Zhongnan Su <[email protected]>
pjfitzgibbons pushed a commit to pjfitzgibbons/OpenSearch-Dashboards that referenced this pull request Mar 24, 2023
@kappassov @ananzh
@AMoo-Miki @zhongnansu
[CCI] Adding second command to Install yarn step in Developer Guide (o…
9821c56 
…pensearch-project#3633)

* added prepare command

Signed-off-by: kappassov <[email protected]>

* Use mirrors to download Node.js binaries to escape sporadic 404 errors (opensearch-project#3619)

Issue Resolved:
opensearch-project#3618

Signed-off-by: Anan Zhuang <[email protected]>

* Allow selecting the Node.js binary OSD uses (opensearch-project#3508)

New reusable use_node scripts take care of selecting the correct Node.js binary based OSD_NODE_HOME, OSD_HOME, and whatever is in the PATH. It also takes care of finding the binary on FreeBSD.
* The startup scripts check `OSD_NODE_HOME` and `NODE_HOME` before falling back to use the bundled or system-wide Node.js binary.
* Update `package.json` to replace `node` with `use_node`.
* Update file templates and shell scripts to internally use `use_node`.
* Update the build scripts to copy `use_node` into releases
* Make tests that execute node internally, honor the binary being used.

Signed-off-by: Miki <[email protected]>

* Clean up and rebuild @osd/pm (opensearch-project#3570)

* Fix the build failures
* Removed some unused packages
* Update gist url templates in Lychee's exclusion list

Signed-off-by: Miki <[email protected]>

* Refactor dev tool console to use opensearch-js client to send request (opensearch-project#3544)

Refactor dev tool console to use opensearch-js client to interact with OpenSearch

Signed-off-by: Su <[email protected]>

* updates after the 1st review

Signed-off-by: kappassov <[email protected]>

---------

Signed-off-by: kappassov <[email protected]>
Signed-off-by: Anan Zhuang <[email protected]>
Signed-off-by: Miki <[email protected]>
Signed-off-by: Su <[email protected]>
Co-authored-by: Anan Zhuang <[email protected]>
Co-authored-by: Miki <[email protected]>
Co-authored-by: Zhongnan Su <[email protected]>
sikhote pushed a commit to sikhote/OpenSearch-Dashboards that referenced this pull request Apr 24, 2023
@kappassov @ananzh
@AMoo-Miki @zhongnansu @sikhote
[CCI] Adding second command to Install yarn step in Developer Guide (o…
5c7953a 
…pensearch-project#3633)

* added prepare command

Signed-off-by: kappassov <[email protected]>

* Use mirrors to download Node.js binaries to escape sporadic 404 errors (opensearch-project#3619)

Issue Resolved:
opensearch-project#3618

Signed-off-by: Anan Zhuang <[email protected]>

* Allow selecting the Node.js binary OSD uses (opensearch-project#3508)

New reusable use_node scripts take care of selecting the correct Node.js binary based OSD_NODE_HOME, OSD_HOME, and whatever is in the PATH. It also takes care of finding the binary on FreeBSD.
* The startup scripts check `OSD_NODE_HOME` and `NODE_HOME` before falling back to use the bundled or system-wide Node.js binary.
* Update `package.json` to replace `node` with `use_node`.
* Update file templates and shell scripts to internally use `use_node`.
* Update the build scripts to copy `use_node` into releases
* Make tests that execute node internally, honor the binary being used.

Signed-off-by: Miki <[email protected]>

* Clean up and rebuild @osd/pm (opensearch-project#3570)

* Fix the build failures
* Removed some unused packages
* Update gist url templates in Lychee's exclusion list

Signed-off-by: Miki <[email protected]>

* Refactor dev tool console to use opensearch-js client to send request (opensearch-project#3544)

Refactor dev tool console to use opensearch-js client to interact with OpenSearch

Signed-off-by: Su <[email protected]>

* updates after the 1st review

Signed-off-by: kappassov <[email protected]>

---------

Signed-off-by: kappassov <[email protected]>
Signed-off-by: Anan Zhuang <[email protected]>
Signed-off-by: Miki <[email protected]>
Signed-off-by: Su <[email protected]>
Co-authored-by: Anan Zhuang <[email protected]>
Co-authored-by: Miki <[email protected]>
Co-authored-by: Zhongnan Su <[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
Reviewers

@joshuarrrr joshuarrrr joshuarrrr approved these changes

@abbyhu2000 abbyhu2000 abbyhu2000 approved these changes

Assignees

@joshuarrrr joshuarrrr

Labels
backport 2.x OSCI Open Source Contributor Initiative Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry v2.7.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@kappassov @joshuarrrr @abbyhu2000 @ananzh @AMoo-Miki @zhongnansu