From 90f3729b9daa5006d5867c7607a8d0b2af901946 Mon Sep 17 00:00:00 2001 From: Pawel Wamej Date: Sat, 12 Feb 2022 19:06:19 +0100 Subject: [PATCH 1/4] remove node version from installation instructions It's outdated (v16 is the active LTS curently) and IMO it's better to link to the Node docs rather than update it every 6 months. Signed-off-by: Pawel Wamej --- docs/getting-started/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index a622313739..7f1d7d6ef5 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -25,7 +25,7 @@ guide to do a repository-based installation. [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/) - An account with elevated rights to install the dependencies - `curl` or `wget` installed -- Node.js Active LTS Release installed (currently v14) using one of these +- [Node.js Active LTS Release](https://nodejs.org/en/about/releases/) installed using one of these methods: - Using `nvm` (recommended) - [Installing nvm](https://github.com/nvm-sh/nvm#install--update-script) From e33e45625ed7a1f6d30240d1bc8f1df9f3e38a68 Mon Sep 17 00:00:00 2001 From: Pawel Wamej Date: Sun, 13 Feb 2022 00:04:26 +0100 Subject: [PATCH 2/4] fix other references to Node LTS Signed-off-by: Pawel Wamej --- docs/getting-started/create-an-app.md | 3 +-- docs/getting-started/running-backstage-locally.md | 7 ++++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/getting-started/create-an-app.md b/docs/getting-started/create-an-app.md index 1d65f25d1b..05c12ffb75 100644 --- a/docs/getting-started/create-an-app.md +++ b/docs/getting-started/create-an-app.md @@ -16,8 +16,7 @@ may want to [Run Backstage Locally](./running-backstage-locally.md) instead. ## Create an app To create a Backstage app, you will need to have -[Node.js](https://nodejs.org/en/download/) Active LTS Release installed -(currently v14). +Node.js [Active LTS Release](https://nodejs.org/en/about/releases/) installed. Backstage provides a utility for creating new apps. It guides you through the initial setup of selecting the name of the app and a database for the backend. diff --git a/docs/getting-started/running-backstage-locally.md b/docs/getting-started/running-backstage-locally.md index daad7bf195..3443b85285 100644 --- a/docs/getting-started/running-backstage-locally.md +++ b/docs/getting-started/running-backstage-locally.md @@ -13,13 +13,14 @@ trying to contribute, follow the instructions to - Node.js -First make sure you are using Node.js with an Active LTS Release, currently v14. +First make sure you are using Node.js with an [Active LTS Release](https://nodejs.org/en/about/releases/). This is made easy with a version manager such as [nvm](https://github.com/nvm-sh/nvm) which allows for version switching. ```bash -# Installing a new version -nvm install 14 +# Installing current LTS release +nvm install --lts +> Installing latest LTS version. > Downloading and installing node v14.15.1... > Now using node v14.15.1 (npm v6.14.8) From c553646511f92587c509143ce1036f58d8162d1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Wamej?= Date: Tue, 15 Feb 2022 07:07:42 +0100 Subject: [PATCH 3/4] keep format consistent Co-authored-by: Andrew Basson Signed-off-by: Pawel Wamej --- docs/getting-started/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 7f1d7d6ef5..69ad4f0160 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -25,7 +25,7 @@ guide to do a repository-based installation. [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/) - An account with elevated rights to install the dependencies - `curl` or `wget` installed -- [Node.js Active LTS Release](https://nodejs.org/en/about/releases/) installed using one of these +Node.js [Active LTS Release](https://nodejs.org/en/about/releases/) installed using one of these methods: - Using `nvm` (recommended) - [Installing nvm](https://github.com/nvm-sh/nvm#install--update-script) From c7a3ae76928697b523b9374800c268a1d80e246d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Wamej?= Date: Wed, 16 Feb 2022 19:46:01 +0100 Subject: [PATCH 4/4] fix missing bullet point Co-authored-by: Patrik Oldsberg --- docs/getting-started/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 69ad4f0160..8c2f6bc865 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -25,7 +25,7 @@ guide to do a repository-based installation. [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/) - An account with elevated rights to install the dependencies - `curl` or `wget` installed -Node.js [Active LTS Release](https://nodejs.org/en/about/releases/) installed using one of these +- Node.js [Active LTS Release](https://nodejs.org/en/about/releases/) installed using one of these methods: - Using `nvm` (recommended) - [Installing nvm](https://github.com/nvm-sh/nvm#install--update-script)