Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #25374 from cdalexndr

Browse Source 
* pr/25374:
  Polish "Add section to update the Reference Documentation"
  Add section to update the Reference Documentation

Closes gh-25374
This commit is contained in:
Stephane Nicoll
2021-04-12 09:33:34 +02:00
parent b9bfc1523f add6a729d3
commit 613462ac22
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.adoc
View File

@@ -74,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).