From 4304d48baedd1bc0bdd43a088985799b00b50903 Mon Sep 17 00:00:00 2001 From: animus888 Date: Fri, 19 Apr 2024 13:39:12 +0200 Subject: [PATCH 1/2] DEV:put nvm installation section into a separate include file --- docs/source/contributing/developing-core.md | 32 +-------------------- docs/source/contributing/install-nvm.md | 32 +++++++++++++++++++++ 2 files changed, 33 insertions(+), 31 deletions(-) create mode 100644 docs/source/contributing/install-nvm.md diff --git a/docs/source/contributing/developing-core.md b/docs/source/contributing/developing-core.md index 690663c3bd..fa6b8ec47b 100644 --- a/docs/source/contributing/developing-core.md +++ b/docs/source/contributing/developing-core.md @@ -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 diff --git a/docs/source/contributing/install-nvm.md b/docs/source/contributing/install-nvm.md new file mode 100644 index 0000000000..93cb8c36ce --- /dev/null +++ b/docs/source/contributing/install-nvm.md @@ -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 + ``` From 4546e424658f8a294c58448821dd1af6f5f8c868 Mon Sep 17 00:00:00 2001 From: animus888 Date: Fri, 19 Apr 2024 13:41:47 +0200 Subject: [PATCH 2/2] DOC: add change log entry --- packages/volto/news/5968.documentation | 1 + 1 file changed, 1 insertion(+) create mode 100644 packages/volto/news/5968.documentation diff --git a/packages/volto/news/5968.documentation b/packages/volto/news/5968.documentation new file mode 100644 index 0000000000..2e944a8dbd --- /dev/null +++ b/packages/volto/news/5968.documentation @@ -0,0 +1 @@ +Put nvm installation section into a separate include file. @animus888