From 527ca9458e411727e7e7e217b8ff8365930aad96 Mon Sep 17 00:00:00 2001 From: Tran Ngoc Nhan Date: Sat, 14 Jun 2025 17:47:17 +0700 Subject: [PATCH 1/2] Update ascii style Signed-off-by: Tran Ngoc Nhan --- docs/modules/ROOT/partials/building.adoc | 2 +- docs/modules/ROOT/partials/contributing.adoc | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/modules/ROOT/partials/building.adoc b/docs/modules/ROOT/partials/building.adoc index 36e69a07..23e533c5 100644 --- a/docs/modules/ROOT/partials/building.adoc +++ b/docs/modules/ROOT/partials/building.adoc @@ -26,7 +26,7 @@ build succeed, please raise a ticket to get the settings added to source control. The projects that require middleware (i.e. Redis) for testing generally -require that a local instance of [Docker](https://www.docker.com/get-started) is installed and running. +require that a local instance of https://www.docker.com/get-started[Docker] is installed and running. [[documentation]] == Documentation diff --git a/docs/modules/ROOT/partials/contributing.adoc b/docs/modules/ROOT/partials/contributing.adoc index 031ce5bd..92e18ab4 100644 --- a/docs/modules/ROOT/partials/contributing.adoc +++ b/docs/modules/ROOT/partials/contributing.adoc @@ -123,10 +123,11 @@ If you need to suppress some rules (e.g. line length needs to be longer), then i It's advisable to copy the `${spring-cloud-build.rootFolder}/.editorconfig` and `${spring-cloud-build.rootFolder}/.springformat` to your project. That way, some default formatting rules will be applied. You can do so by running this script: -```bash +[source,bash] +---- $ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/.editorconfig -o .editorconfig $ touch .springformat -``` +---- [[ide-setup]] == IDE setup From ea9a1a8012beab1bf38d99cf3eaa0e96f7f3624f Mon Sep 17 00:00:00 2001 From: Tran Ngoc Nhan Date: Sat, 14 Jun 2025 17:47:45 +0700 Subject: [PATCH 2/2] Fix typo Signed-off-by: Tran Ngoc Nhan --- docs/modules/ROOT/partials/contributing.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/partials/contributing.adoc b/docs/modules/ROOT/partials/contributing.adoc index 92e18ab4..f47d4f46 100644 --- a/docs/modules/ROOT/partials/contributing.adoc +++ b/docs/modules/ROOT/partials/contributing.adoc @@ -109,7 +109,7 @@ Checkstyle rules are *disabled by default*. To add checkstyle to your project ju If you need to suppress some rules (e.g. line length needs to be longer), then it's enough for you to define a file under `${project.root}/src/checkstyle/checkstyle-suppressions.xml` with your suppressions. Example: -.projectRoot/src/checkstyle/checkstyle-suppresions.xml +.projectRoot/src/checkstyle/checkstyle-suppressions.xml ----