Spring/spring-boot
Spring/spring-boot
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-boot.git synced 2024-07-05 00:56:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

Polish "Add section to update the Reference Documentation"

Browse Source 
See gh-25374
This commit is contained in:
Stephane Nicoll 2021-04-12 09:32:48 +02:00
parent 4a9e3202e1
commit add6a729d3
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.adoc
View File

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