Skip to content

Commit

Permalink
DEV: put nvm installation section into a separate include file (#5968)
Browse files Browse the repository at this point in the history
Co-authored-by: Steve Piercy <web@stevepiercy.com>
  • Loading branch information
animus888 and stevepiercy committed Apr 19, 2024
1 parent 6f18663 commit c7de2e9
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 31 deletions.
32 changes: 1 addition & 31 deletions docs/source/contributing/developing-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,39 +84,9 @@ When developing a project using Plone, Yarn or other package managers may be use

### nvm

The following terminal session commands use `bash` for the shell.
Adapt them for your flavor of shell.

```{seealso}
See the [`nvm` install and update script documentation](https://github.com/nvm-sh/nvm#install--update-script).
For the `fish` shell, see [`nvm.fish`](https://github.com/jorgebucaran/nvm.fish).
```{include} ./install-nvm.md
```

1. Create your shell profile, if it does not exist.

```shell
touch ~/.bash_profile
```

2. Download and run the `nvm` install and update script, and pipe it into `bash`.

```shell
curl -o- https://raw.githubusercontent.com/creationix/nvm/v{NVM_VERSION}/install.sh | bash
```

3. Source your profile.
Alternatively close the session and open a new one.

```shell
source ~/.bash_profile
```

4. Verify that the `nvm` version is that which you just installed or updated:

```shell
nvm --version
```


### Node.js

Expand Down
32 changes: 32 additions & 0 deletions docs/source/contributing/install-nvm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
The following terminal session commands use `bash` for the shell.
Adapt them for your flavor of shell.

```{seealso}
See the [`nvm` install and update script documentation](https://github.com/nvm-sh/nvm#install--update-script).
For the `fish` shell, see [`nvm.fish`](https://github.com/jorgebucaran/nvm.fish).
```

1. Create your shell profile, if it does not exist.

```shell
touch ~/.bash_profile
```

2. Download and run the `nvm` install and update script, and pipe it into `bash`.

```shell
curl -o- https://raw.githubusercontent.com/creationix/nvm/v{NVM_VERSION}/install.sh | bash
```

3. Source your profile.
Alternatively close the session and open a new one.

```shell
source ~/.bash_profile
```

4. Verify that the `nvm` version is that which you just installed or updated:

```shell
nvm --version
```
1 change: 1 addition & 0 deletions packages/volto/news/5968.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Put nvm installation section into a separate include file. @animus888

0 comments on commit c7de2e9

Please sign in to comment.