From 0fe9a4023ac3c179f0d2de5539ba0ce28b186126 Mon Sep 17 00:00:00 2001 From: Matt Raible Date: Sun, 27 Oct 2024 21:20:51 -0600 Subject: [PATCH] Improve Docker documentation in README (#27702) --- .../templates/README.md.jhi.spring-boot.ejs | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/generators/spring-boot/templates/README.md.jhi.spring-boot.ejs b/generators/spring-boot/templates/README.md.jhi.spring-boot.ejs index b4fb62143398..20910459ff5e 100644 --- a/generators/spring-boot/templates/README.md.jhi.spring-boot.ejs +++ b/generators/spring-boot/templates/README.md.jhi.spring-boot.ejs @@ -331,21 +331,21 @@ For more information, refer to the [Code quality page][]. ### Docker Compose support -JHipster generates a number of docker-compose configuration files in the [<%- dockerServicesDir %>](<%- dockerServicesDir %>) folder to launch required third party services. +JHipster generates a number of Docker Compose configuration files in the [<%- dockerServicesDir %>](<%- dockerServicesDir %>) folder to launch required third party services. -For example, to start required services in docker containers, run: +For example, to start required services in Docker containers, run: ``` docker compose -f <%- dockerServicesDir %>services.yml up -d ``` -To stop it and remove the containers, run: +To stop and remove the containers, run: ``` docker compose -f <%- dockerServicesDir %>services.yml down ``` -[Spring Docker Compose Integration](https://docs.spring.io/spring-boot/reference/features/dev-services.html) is enable by default. Is possible to disable it in application.yml: +[Spring Docker Compose Integration](https://docs.spring.io/spring-boot/reference/features/dev-services.html) is enable by default. It's possible to disable it in application.yml: ```yaml spring: @@ -356,13 +356,13 @@ spring: ``` You can also fully dockerize your application and all the services that it depends on. -To achieve this, first build a docker image of your app by running: +To achieve this, first build a Docker image of your app by running: ```sh npm run java:docker ``` -Or build a arm64 docker image when using an arm64 processor os like MacOS with M1 processor family running: +Or build a arm64 Docker image when using an arm64 processor os like MacOS with M1 processor family running: ```sh npm run java:docker:arm64 @@ -374,7 +374,7 @@ Then run: docker compose -f <%- dockerServicesDir %>app.yml up -d ``` -For more information refer to [Using Docker and Docker-Compose][], this page also contains information on the docker-compose sub-generator (`jhipster docker-compose`), which is able to generate docker configurations for one or several JHipster applications. +For more information refer to [Using Docker and Docker-Compose][], this page also contains information on the Docker Compose sub-generator (`jhipster docker-compose`), which is able to generate Docker configurations for one or several JHipster applications. ## Continuous Integration (optional)