From a46cb8d24c600f3cad71966f65aa3412d26f0131 Mon Sep 17 00:00:00 2001 From: Tim Holm Date: Mon, 9 Sep 2024 14:38:26 +1000 Subject: [PATCH 1/4] docs: Add a note on docker for linux setup in prerequisites. --- src/pages/getting-started/installation.mdx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/pages/getting-started/installation.mdx b/src/pages/getting-started/installation.mdx index 67bd2d5f5..e95f53923 100644 --- a/src/pages/getting-started/installation.mdx +++ b/src/pages/getting-started/installation.mdx @@ -12,10 +12,14 @@ Nitric relies on functionality from the following projects to help retrieve plug Please follow these links to the official installation steps for each. - [Git](https://git-scm.com/) -- [Docker](https://docs.docker.com/get-docker/) _(deployments only)_ +- [Docker](https://docs.docker.com/get-docker/) - [Docker Buildx](https://github.com/docker/buildx/) _(deployments only)_ - [Pulumi](https://www.pulumi.com/docs/cli/) _(for deployments, only needed if using the default providers)_ + +When setting up docker on Linux be sure to follow the [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/) so you can run docker as a non-root user. + + ## Installing the Nitric CLI From 9f34d89501289051569f4b4611e39bad9705fb2d Mon Sep 17 00:00:00 2001 From: Tim Holm Date: Mon, 9 Sep 2024 14:49:26 +1000 Subject: [PATCH 2/4] format:fix. --- src/pages/getting-started/installation.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/pages/getting-started/installation.mdx b/src/pages/getting-started/installation.mdx index e95f53923..30672f626 100644 --- a/src/pages/getting-started/installation.mdx +++ b/src/pages/getting-started/installation.mdx @@ -17,7 +17,9 @@ Please follow these links to the official installation steps for each. - [Pulumi](https://www.pulumi.com/docs/cli/) _(for deployments, only needed if using the default providers)_ -When setting up docker on Linux be sure to follow the [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/) so you can run docker as a non-root user. + When setting up docker on Linux be sure to follow the [post-installation + steps](https://docs.docker.com/engine/install/linux-postinstall/) so you can + run docker as a non-root user. ## Installing the Nitric CLI From 45f7d79126f4f9c5c4671cc6be1925bad231206a Mon Sep 17 00:00:00 2001 From: Ryan Cartwright Date: Mon, 9 Sep 2024 17:59:05 +1000 Subject: [PATCH 3/4] remove deployment only caveat for docker installation --- src/pages/getting-started/installation.mdx | 2 +- src/pages/reference/cli/installation.mdx | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/pages/getting-started/installation.mdx b/src/pages/getting-started/installation.mdx index 30672f626..7bf7bf77d 100644 --- a/src/pages/getting-started/installation.mdx +++ b/src/pages/getting-started/installation.mdx @@ -13,7 +13,7 @@ Please follow these links to the official installation steps for each. - [Git](https://git-scm.com/) - [Docker](https://docs.docker.com/get-docker/) -- [Docker Buildx](https://github.com/docker/buildx/) _(deployments only)_ +- [Docker Buildx](https://github.com/docker/buildx/) - [Pulumi](https://www.pulumi.com/docs/cli/) _(for deployments, only needed if using the default providers)_ diff --git a/src/pages/reference/cli/installation.mdx b/src/pages/reference/cli/installation.mdx index 3b0ecb0ed..70657306a 100644 --- a/src/pages/reference/cli/installation.mdx +++ b/src/pages/reference/cli/installation.mdx @@ -9,8 +9,8 @@ Nitric relies on functionality from the following projects to help retrieve plug Please follow these links to the official installation steps for each. - [Git](https://git-scm.com/) -- [Docker](https://docs.docker.com/get-docker/) _(deployments only)_ -- [Docker Buildx](https://github.com/docker/buildx/) _(deployments only)_ +- [Docker](https://docs.docker.com/get-docker/) +- [Docker Buildx](https://github.com/docker/buildx/) - [Pulumi](https://www.pulumi.com/docs/cli/) _(for deployments, only needed if using the default providers)_ ## Installing the Nitric CLI From ce7937e202132137c12407fc671ec7306a592603 Mon Sep 17 00:00:00 2001 From: Ryan Cartwright Date: Mon, 9 Sep 2024 18:02:37 +1000 Subject: [PATCH 4/4] add extra note for CLI installation --- src/pages/reference/cli/installation.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/pages/reference/cli/installation.mdx b/src/pages/reference/cli/installation.mdx index 70657306a..b571efe42 100644 --- a/src/pages/reference/cli/installation.mdx +++ b/src/pages/reference/cli/installation.mdx @@ -13,6 +13,12 @@ Please follow these links to the official installation steps for each. - [Docker Buildx](https://github.com/docker/buildx/) - [Pulumi](https://www.pulumi.com/docs/cli/) _(for deployments, only needed if using the default providers)_ + + When setting up docker on Linux be sure to follow the [post-installation + steps](https://docs.docker.com/engine/install/linux-postinstall/) so you can + run docker as a non-root user. + + ## Installing the Nitric CLI