From 9ae08880dffd0274518b3e38bccb5923bda31ab5 Mon Sep 17 00:00:00 2001 From: maliming Date: Fri, 20 Dec 2024 14:05:12 +0800 Subject: [PATCH 1/6] Revise `Pre-Requirements` document. Resolve #21686 --- docs/en/get-started/pre-requirements.md | 36 +++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/en/get-started/pre-requirements.md b/docs/en/get-started/pre-requirements.md index 300c26a94f..d761e8b8bd 100644 --- a/docs/en/get-started/pre-requirements.md +++ b/docs/en/get-started/pre-requirements.md @@ -2,6 +2,13 @@ This document will guide you through preparing your development environment for ABP based application development. +> The prerequisites mentioned in this document are not all necessary. It based on your project type. + +* You don't need to install the EF Core CLI if your application uses MongoDB instead of EF Core. +* You don't need to use Redis(distributed cache) if your application has only one instance. See [When to Use a Distributed Cache Server](../kb/when-to-use-a-distributed-cache-server.md). +* You don't need to install Helm, NGINX Ingress, or mkcert if you are developing a non-microservice application. +* The `README.md` file in the solution will contain specific requirements for the current solution. Please refer to the `README.md` file of the solution. + ## IDE You need to use an IDE that supports .NET development. The following IDEs are the most popular ones for .NET development. @@ -70,3 +77,32 @@ ABP startup solution templates and tools use some PowerShell scripts (`*.ps1`) t * [Install PowerShell on Windows](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows) * [Install PowerShell on macOS](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-macos) * [Install PowerShell on Linux](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-linux) + +## MicroService Solution + +The following tools are only required to develop ABP's [microservice solution](../solution-templates/microservice/index.md) + +### Helm + +[Helm](https://helm.sh/) is a package manager for Kubernetes. You can install Helm by following the [Helm installation guide](https://helm.sh/docs/intro/install/). + +See [Helm Deployment on Local Kubernetes Cluster](../solution-templates/microservice/helm-charts-and-kubernetes.md) for more information. + +### NGINX Ingress or NGINX Ingress using Helm + +[NGINX Ingress](https://kubernetes.github.io/ingress-nginx/deploy/) is an Ingress controller for Kubernetes. You can install NGINX Ingress by following the [NGINX Ingress installation guide](https://kubernetes.github.io/ingress-nginx/deploy/). + +If you are using Helm, you can install NGINX Ingress using the following commands: +```cs +helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx +helm repo update +helm upgrade --install --version=4.0.19 ingress-nginx ingress-nginx/ingress-nginx +``` + +### mkcert + +Use mkcert to generate trusted certificates for local development. You can install mkcert by following the [official mkcert installation guide](https://github.com/FiloSottile/mkcert#installation). + +### Docker Engine or Docker Desktop + +Docker is required to run the infrastructure services required by your application. You can install Docker Engine or Docker Desktop by following the above instructions. From 3a75aef7d81029f3d83990d03f3491d9663baf8d Mon Sep 17 00:00:00 2001 From: maliming Date: Fri, 20 Dec 2024 14:13:02 +0800 Subject: [PATCH 2/6] Update pre-requirements.md --- docs/en/get-started/pre-requirements.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/en/get-started/pre-requirements.md b/docs/en/get-started/pre-requirements.md index d761e8b8bd..4ac4e67502 100644 --- a/docs/en/get-started/pre-requirements.md +++ b/docs/en/get-started/pre-requirements.md @@ -82,6 +82,10 @@ ABP startup solution templates and tools use some PowerShell scripts (`*.ps1`) t The following tools are only required to develop ABP's [microservice solution](../solution-templates/microservice/index.md) +### Docker Engine or Docker Desktop + +Docker is required to run essential infrastructure services like SQL Server/MongoDB, Redis, RabbitMQ, and Elastic Stack for your microservice application. Follow the instructions above to install Docker Engine or Docker Desktop. + ### Helm [Helm](https://helm.sh/) is a package manager for Kubernetes. You can install Helm by following the [Helm installation guide](https://helm.sh/docs/intro/install/). @@ -93,6 +97,7 @@ See [Helm Deployment on Local Kubernetes Cluster](../solution-templates/microser [NGINX Ingress](https://kubernetes.github.io/ingress-nginx/deploy/) is an Ingress controller for Kubernetes. You can install NGINX Ingress by following the [NGINX Ingress installation guide](https://kubernetes.github.io/ingress-nginx/deploy/). If you are using Helm, you can install NGINX Ingress using the following commands: + ```cs helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx helm repo update @@ -102,7 +107,3 @@ helm upgrade --install --version=4.0.19 ingress-nginx ingress-nginx/ingress-ngin ### mkcert Use mkcert to generate trusted certificates for local development. You can install mkcert by following the [official mkcert installation guide](https://github.com/FiloSottile/mkcert#installation). - -### Docker Engine or Docker Desktop - -Docker is required to run the infrastructure services required by your application. You can install Docker Engine or Docker Desktop by following the above instructions. From 1ef6d5f682efa1b43d73b3861d9a9b1d2cc3f69e Mon Sep 17 00:00:00 2001 From: maliming Date: Fri, 20 Dec 2024 14:14:26 +0800 Subject: [PATCH 3/6] Update pre-requirements.md --- docs/en/get-started/pre-requirements.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/get-started/pre-requirements.md b/docs/en/get-started/pre-requirements.md index 4ac4e67502..582a6dab73 100644 --- a/docs/en/get-started/pre-requirements.md +++ b/docs/en/get-started/pre-requirements.md @@ -2,11 +2,11 @@ This document will guide you through preparing your development environment for ABP based application development. -> The prerequisites mentioned in this document are not all necessary. It based on your project type. +> The prerequisites mentioned in this document are not all necessary. It is based on your project type. * You don't need to install the EF Core CLI if your application uses MongoDB instead of EF Core. * You don't need to use Redis(distributed cache) if your application has only one instance. See [When to Use a Distributed Cache Server](../kb/when-to-use-a-distributed-cache-server.md). -* You don't need to install Helm, NGINX Ingress, or mkcert if you are developing a non-microservice application. +* You don't need to install Docker, Helm, NGINX Ingress, or mkcert if you are developing a non-microservice application. * The `README.md` file in the solution will contain specific requirements for the current solution. Please refer to the `README.md` file of the solution. ## IDE From c8804bbde954579fe125c2b5d2d6663d43d09bad Mon Sep 17 00:00:00 2001 From: maliming Date: Fri, 20 Dec 2024 16:56:50 +0800 Subject: [PATCH 4/6] Update pre-requirements.md --- docs/en/get-started/pre-requirements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/get-started/pre-requirements.md b/docs/en/get-started/pre-requirements.md index 582a6dab73..5122380eca 100644 --- a/docs/en/get-started/pre-requirements.md +++ b/docs/en/get-started/pre-requirements.md @@ -5,7 +5,7 @@ This document will guide you through preparing your development environment for > The prerequisites mentioned in this document are not all necessary. It is based on your project type. * You don't need to install the EF Core CLI if your application uses MongoDB instead of EF Core. -* You don't need to use Redis(distributed cache) if your application has only one instance. See [When to Use a Distributed Cache Server](../kb/when-to-use-a-distributed-cache-server.md). +* You don't need to use Redis(distributed cache) if your application has only one instance. * You don't need to install Docker, Helm, NGINX Ingress, or mkcert if you are developing a non-microservice application. * The `README.md` file in the solution will contain specific requirements for the current solution. Please refer to the `README.md` file of the solution. From 19bbce0294d756aea0f24c3623b235614ca60508 Mon Sep 17 00:00:00 2001 From: maliming Date: Fri, 20 Dec 2024 17:08:40 +0800 Subject: [PATCH 5/6] Update pre-requirements.md --- docs/en/get-started/pre-requirements.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/en/get-started/pre-requirements.md b/docs/en/get-started/pre-requirements.md index 5122380eca..0763fa2489 100644 --- a/docs/en/get-started/pre-requirements.md +++ b/docs/en/get-started/pre-requirements.md @@ -59,7 +59,7 @@ npm install --global yarn ## Docker Engine or Docker Desktop -ABP's [startup solution templates](../solution-templates/index.md) use Docker to run infrastructure services (e.g. Redis, RabbitMQ) required by your application. You can install Docker Engine or Docker Desktop (recommended) on Windows, macOS and Linux. +ABP's [Layered Solution](../solution-templates/layered-web-application/index.md) and [Microservice Solution](../solution-templates/microservice/index.md) use Docker to run infrastructure services (e.g. SQL Server, Redis, RabbitMQ) required by your application. You can install Docker Engine or Docker Desktop (recommended) on Windows, macOS and Linux. * [Docker Desktop](https://www.docker.com/products/docker-desktop/) (recommended) * [Docker Engine](https://docs.docker.com/engine/install/) @@ -82,10 +82,6 @@ ABP startup solution templates and tools use some PowerShell scripts (`*.ps1`) t The following tools are only required to develop ABP's [microservice solution](../solution-templates/microservice/index.md) -### Docker Engine or Docker Desktop - -Docker is required to run essential infrastructure services like SQL Server/MongoDB, Redis, RabbitMQ, and Elastic Stack for your microservice application. Follow the instructions above to install Docker Engine or Docker Desktop. - ### Helm [Helm](https://helm.sh/) is a package manager for Kubernetes. You can install Helm by following the [Helm installation guide](https://helm.sh/docs/intro/install/). From a449bbf0b925b192cc7c4dba3d3ec72d376b34bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Halil=20=C4=B0brahim=20Kalkan?= Date: Fri, 20 Dec 2024 12:13:58 +0300 Subject: [PATCH 6/6] Update pre-requirements.md --- docs/en/get-started/pre-requirements.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/en/get-started/pre-requirements.md b/docs/en/get-started/pre-requirements.md index 0763fa2489..c1c7b39c28 100644 --- a/docs/en/get-started/pre-requirements.md +++ b/docs/en/get-started/pre-requirements.md @@ -2,12 +2,14 @@ This document will guide you through preparing your development environment for ABP based application development. -> The prerequisites mentioned in this document are not all necessary. It is based on your project type. +## Notices + +The prerequisites mentioned in this document are not necessary for every project type; * You don't need to install the EF Core CLI if your application uses MongoDB instead of EF Core. -* You don't need to use Redis(distributed cache) if your application has only one instance. -* You don't need to install Docker, Helm, NGINX Ingress, or mkcert if you are developing a non-microservice application. -* The `README.md` file in the solution will contain specific requirements for the current solution. Please refer to the `README.md` file of the solution. +* You don't need to install Helm, NGINX Ingress, or mkcert if you are developing a non-microservice application. + +`README.MD` files in new solutions contain specific requirements for your solution. Please refer to the `README.MD` file of your solution. ## IDE