From add6a729d39dd2956d07a7b0741b5d1e8af6803f Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Mon, 12 Apr 2021 09:32:48 +0200 Subject: [PATCH] Polish "Add section to update the Reference Documentation" See gh-25374 --- CONTRIBUTING.adoc | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index ec89843fbd..afed80d0d6 100755 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -31,12 +31,7 @@ Before we accept a non-trivial patch or pull request we will need you to https:/ Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests. -== Documentation contributions -The documentation is stored in this repository, in the link:https://github.com/spring-projects/spring-boot/tree/master/spring-boot-project/spring-boot-docs/src/docs/asciidoc[spring-boot-docs] project. - -You may use GitHub's built-in editor for Asciidoc by pressing the top-right Edit button to edit the documentation in browser. -Alternatively, you can clone and change it in an editor of your choice on your machine. == Code Conventions and Housekeeping None of these is essential for a pull request, but they will all help. They can also be @@ -79,6 +74,19 @@ The project can be built from the root directory using the standard Gradle comma +== Updating the Reference Documentation +The reference documentation is stored in this repository, see `spring-boot-project/spring-boot-docs/src/docs/asciidoc`. +We use https://asciidoctor.org/docs/asciidoc-writers-guide/[Asciidoc] and you can build the documentation locally using this command: + +[indent=0] +---- + $ ./gradlew spring-boot-project:spring-boot-docs:asciidoc +---- + +NOTE: The generated HTML documentation is available from `spring-boot-project/spring-boot-docs/build/docs/asciidoc/`. + + + === Importing into Eclipse You can import the Spring Boot code into any Eclipse 2019-12-based distribution. The easiest way to setup a new environment is to use the Eclipse Installer with the provided `spring-boot-project.setup` file (in the `/eclipse` folder).