Skip to content

Commit

Permalink
Update yarn install step from dev guide (opensearch-project#5067)
Browse files Browse the repository at this point in the history
* Update yarn install step from dev guide

Signed-off-by: Matt Provost <provomat@amazon.com>

* Update the corepack command

Signed-off-by: Matt Provost <provomat@amazon.com>

* Update to use corepack install

Signed-off-by: Matt Provost <provomat@amazon.com>

* Revise corepack url

Signed-off-by: Matt Provost <provomat@amazon.com>

---------

Signed-off-by: Matt Provost <provomat@amazon.com>
  • Loading branch information
BSFishy authored Sep 22, 2023
1 parent eec3ed7 commit 46d7c2d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
10 changes: 7 additions & 3 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,17 @@ If it's the only version of node installed, it will automatically be set to the

#### Install `yarn`

To install yarn run:
OpenSearch Dashboards is set up using yarn, which can be installed through corepack. To install yarn, run:

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

$ # Install the correct version of yarn
$ corepack install
```

(See the [Yarn installation documentation](https://yarnpkg.com/getting-started/install) for more information.)
(See the [corepack documentation](https://github.com/nodejs/corepack#-corepack) for more information.)

### Fork and clone OpenSearch Dashboards

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"bugs": {
"url": "http://github.com/opensearch-project/OpenSearch-Dashboards/issues"
},
"packageManager": "yarn@1.22.19",
"opensearchDashboards": {
"clean": {
"extraPatterns": [
Expand Down

0 comments on commit 46d7c2d

Please sign in to comment.