Update yarn install step from dev guide

[BSFishy]

Description

Update developer guide after #5065 was merged. I was concerned because everything I've seen says to install yarn through corepack, so I did some digging. The old dev guide said to install yarn using the latest version from yarn trunk (v3 something), which would break bootstrap and everything with that. However, OSD is built using yarn v1, which is incompatible with yarn v3. Essentially, there are significant differences between yarn v1 and v3, which make all of the guides in Dashboards break, since they were built for v1 instead of v3. This PR updates the guides to use corepack, which is the recommended way to install yarn, but to still install v1.

Issues Resolved

N/a

Screenshot

N/a

Testing the changes

Ran this on Node version 14, 16, and 18 to get yarn v1.22.18 installed and tested clean and bootstrap with that version.

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

[BSFishy]

Previously, we had corepack prepare .... The prepare subcommand doesn't exist in newer versions of corepack: https://github.com/nodejs/corepack?tab=readme-ov-file#utility-commands

Instead, the enable subcommand should add all relevant package managers (including yarn).

[manasvinibs]

Nice!

[dtaivpp]

Thanks!

[BSFishy]

Additionally, we could modify it to be something like this:

$ # Update corepack to the latest version
$ npm i -g corepack

$ # Install the correct version of yarn
$ corepack install

And have something like this in our package.json:

{
  "packageManager": "yarn@1.22.19"
}

That will potentially make this even better, by ensuring everyone has the same version of yarn installed.

(reference: https://github.com/nodejs/corepack?tab=readme-ov-file#when-authoring-packages)

[joshuarrrr]

Additionally, we could modify it to be something like this:

$ # Update corepack to the latest version
$ npm i -g corepack

$ # Install the correct version of yarn
$ corepack install

And have something like this in our package.json:

{
  "packageManager": "yarn@1.22.19"
}

That will potentially make this even better, by ensuring everyone has the same version of yarn installed.

(reference: https://github.com/nodejs/corepack?tab=readme-ov-file#when-authoring-packages)

I'd definitely prefer that direction even more. Anything we can do to standardize the process and eliminate potential ambiguity would be great!

[codecov]

Codecov Report

Merging #5067 (73509dd) into main (b9b2b79) will not change coverage.
Report is 3 commits behind head on main.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #5067   +/-   ##
=======================================
  Coverage   66.50%   66.50%           
=======================================
  Files        3403     3403           
  Lines       65026    65026           
  Branches    10401    10401           
=======================================
  Hits        43243    43243           
  Misses      19214    19214           
  Partials     2569     2569           

Flag	Coverage Δ
Linux_1	34.82% <ø> (ø)
Linux_2	55.31% <ø> (ø)
Linux_3	44.60% <ø> (ø)
Linux_4	34.89% <ø> (ø)
Windows_1	34.83% <ø> (ø)
Windows_2	55.27% <ø> (ø)
Windows_3	44.61% <ø> (ø)
Windows_4	34.89% <ø> (ø)

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

[opensearch-trigger-bot]

The backport to 1.3 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-1.3 1.3
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-1.3
# Create a new branch
git switch --create backport/backport-5067-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 46d7c2d8c1f3af737697ee984d31ea1cccf85494
# Push it to GitHub
git push --set-upstream origin backport/backport-5067-to-1.3
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-1.3

Then, create a pull request where the base branch is 1.3 and the compare/head branch is backport/backport-5067-to-1.3.

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-5067-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 46d7c2d8c1f3af737697ee984d31ea1cccf85494
# Push it to GitHub
git push --set-upstream origin backport/backport-5067-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-5067-to-2.x.