Skip to content

Commit 4849f8f

Browse files
committed
Polish asciidoc formatting
1 parent f396c51 commit 4849f8f

File tree

5 files changed

+71
-30
lines changed

5 files changed

+71
-30
lines changed

CONTRIBUTING.adoc

+6
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ Spring Boot is released under the Apache 2.0 license. If you would like to contr
55

66

77
== Code of Conduct
8+
89
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of conduct].
910
By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
1011

1112

1213

1314
== Using GitHub Issues
15+
1416
We use GitHub issues to track bugs and enhancements.
1517
If you have a general usage question please ask on https://stackoverflow.com[Stack Overflow].
1618
The Spring Boot team and the broader community monitor the https://stackoverflow.com/tags/spring-boot[`spring-boot`] tag.
@@ -21,19 +23,22 @@ Ideally, that would include a small sample project that reproduces the problem.
2123

2224

2325
== Reporting Security Vulnerabilities
26+
2427
If you think you have found a security vulnerability in Spring Boot please *DO NOT* disclose it publicly until we've had a chance to fix it.
2528
Please don't report security vulnerabilities using GitHub issues, instead head over to https://spring.io/security-policy and learn how to disclose them responsibly.
2629

2730

2831

2932
== Sign the Contributor License Agreement
33+
3034
Before we accept a non-trivial patch or pull request we will need you to https://cla.pivotal.io/sign/spring[sign the Contributor License Agreement].
3135
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.
3236
Active contributors might be asked to join the core team, and given the ability to merge pull requests.
3337

3438

3539

3640
== Code Conventions and Housekeeping
41+
3742
None of these is essential for a pull request, but they will all help. They can also be
3843
added after the original pull request but before a merge.
3944

@@ -55,4 +60,5 @@ added after the original pull request but before a merge.
5560

5661

5762
== Working with the Code
63+
5864
For information on editing, building, and testing the code, see the https://github.com/spring-projects/spring-boot/wiki/Working-with-the-Code[Working with the Code] page on the project wiki.

README.adoc

+35-19
Original file line numberDiff line numberDiff line change
@@ -19,35 +19,37 @@ Our primary goals are:
1919
2020
2121
== Installation and Getting Started
22+
2223
The {docs}/html/[reference documentation] includes detailed {docs}/html/getting-started.html#getting-started-installing-spring-boot[installation instructions] as well as a comprehensive {docs}/html/getting-started.html#getting-started-first-application[``getting started``] guide.
2324

2425
Here is a quick teaser of a complete Spring Boot application in Java:
2526

26-
[source,java,indent=0]
27+
[source,java]
2728
----
28-
import org.springframework.boot.*;
29-
import org.springframework.boot.autoconfigure.*;
30-
import org.springframework.web.bind.annotation.*;
31-
32-
@RestController
33-
@SpringBootApplication
34-
public class Example {
29+
import org.springframework.boot.*;
30+
import org.springframework.boot.autoconfigure.*;
31+
import org.springframework.web.bind.annotation.*;
3532
36-
@RequestMapping("/")
37-
String home() {
38-
return "Hello World!";
39-
}
33+
@RestController
34+
@SpringBootApplication
35+
public class Example {
4036
41-
public static void main(String[] args) {
42-
SpringApplication.run(Example.class, args);
43-
}
37+
@RequestMapping("/")
38+
String home() {
39+
return "Hello World!";
40+
}
4441
42+
public static void main(String[] args) {
43+
SpringApplication.run(Example.class, args);
4544
}
45+
46+
}
4647
----
4748

4849

4950

5051
== Getting Help
52+
5153
Are you having trouble with Spring Boot? We want to help!
5254

5355
* Check the {docs}/html/[reference documentation], especially the {docs}/html/howto.html#howto[How-to's] -- they provide solutions to the most common questions.
@@ -61,6 +63,7 @@ Are you having trouble with Spring Boot? We want to help!
6163

6264

6365
== Reporting Issues
66+
6467
Spring Boot uses GitHub's integrated issue tracking system to record bugs and feature requests.
6568
If you want to raise an issue, please follow the recommendations below:
6669

@@ -75,31 +78,34 @@ We like to know the Spring Boot version, operating system, and JVM version you'r
7578

7679

7780
== Building from Source
81+
7882
You don't need to build from source to use Spring Boot (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Boot can be built and published to your local Maven cache using the https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle wrapper].
7983
You also need JDK 17.
8084

81-
[indent=0]
85+
[source,shell]
8286
----
83-
$ ./gradlew publishToMavenLocal
87+
$ ./gradlew publishToMavenLocal
8488
----
8589

8690
This will build all of the jars and documentation and publish them to your local Maven cache.
8791
It won't run any of the tests.
8892
If you want to build everything, use the `build` task:
8993

90-
[indent=0]
94+
[source,shell]
9195
----
92-
$ ./gradlew build
96+
$ ./gradlew build
9397
----
9498

9599

96100

97101
== Modules
102+
98103
There are several modules in Spring Boot. Here is a quick overview:
99104

100105

101106

102107
=== spring-boot
108+
103109
The main library providing features that support the other parts of Spring Boot. These include:
104110

105111
* The `SpringApplication` class, providing static convenience methods that can be used to write a stand-alone Spring Application.
@@ -111,6 +117,7 @@ The main library providing features that support the other parts of Spring Boot.
111117

112118

113119
=== spring-boot-autoconfigure
120+
114121
Spring Boot can configure large parts of typical applications based on the content of their classpath.
115122
A single `@EnableAutoConfiguration` annotation triggers auto-configuration of the Spring context.
116123

@@ -120,13 +127,15 @@ Auto-configuration will always back away as the user starts to define their own
120127

121128

122129
=== spring-boot-starters
130+
123131
Starters are a set of convenient dependency descriptors that you can include in your application.
124132
You get a one-stop shop for all the Spring and related technology you need without having to hunt through sample code and copy-paste loads of dependency descriptors.
125133
For example, if you want to get started using Spring and JPA for database access, include the `spring-boot-starter-data-jpa` dependency in your project, and you are good to go.
126134

127135

128136

129137
=== spring-boot-actuator
138+
130139
Actuator endpoints let you monitor and interact with your application.
131140
Spring Boot Actuator provides the infrastructure required for actuator endpoints.
132141
It contains annotation support for actuator endpoints.
@@ -135,6 +144,7 @@ This module provides many endpoints, including the `HealthEndpoint`, `Environmen
135144

136145

137146
=== spring-boot-actuator-autoconfigure
147+
138148
This provides auto-configuration for actuator endpoints based on the content of the classpath and a set of properties.
139149
For instance, if Micrometer is on the classpath, it will auto-configure the `MetricsEndpoint`.
140150
It contains configuration to expose endpoints over HTTP or JMX.
@@ -143,29 +153,34 @@ Just like Spring Boot AutoConfigure, this will back away as the user starts to d
143153

144154

145155
=== spring-boot-test
156+
146157
This module contains core items and annotations that can be helpful when testing your application.
147158

148159

149160

150161
=== spring-boot-test-autoconfigure
162+
151163
Like other Spring Boot auto-configuration modules, spring-boot-test-autoconfigure provides auto-configuration for tests based on the classpath.
152164
It includes many annotations that can automatically configure a slice of your application that needs to be tested.
153165

154166

155167

156168
=== spring-boot-loader
169+
157170
Spring Boot Loader provides the secret sauce that allows you to build a single jar file that can be launched using `java -jar`.
158171
Generally, you will not need to use `spring-boot-loader` directly but work with the link:spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin[Gradle] or link:spring-boot-project/spring-boot-tools/spring-boot-maven-plugin[Maven] plugin instead.
159172

160173

161174

162175
=== spring-boot-devtools
176+
163177
The spring-boot-devtools module provides additional development-time features, such as automatic restarts, for a smoother application development experience.
164178
Developer tools are automatically disabled when running a fully packaged application.
165179

166180

167181

168182
== Guides
183+
169184
The https://spring.io/[spring.io] site contains several guides that show how to use Spring Boot step-by-step:
170185

171186
* https://spring.io/guides/gs/spring-boot/[Building an Application with Spring Boot] is an introductory guide that shows you how to create an application, run it, and add some management services.
@@ -175,4 +190,5 @@ The https://spring.io/[spring.io] site contains several guides that show how to
175190

176191

177192
== License
193+
178194
Spring Boot is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].

SUPPORT.adoc

+12
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
= Getting support for Spring Boot
22

3+
4+
35
== GitHub issues
6+
47
We choose not to use GitHub issues for general usage questions and support, preferring to
58
use issues solely for the tracking of bugs and enhancements. If you have a general
69
usage question please do not open a GitHub issue, but use one of the other channels
@@ -10,17 +13,26 @@ If you are reporting a bug, please help to speed up problem diagnosis by providi
1013
much information as possible. Ideally, that would include a small sample project that
1114
reproduces the problem.
1215

16+
17+
1318
== Stack Overflow
19+
1420
The Spring Boot community monitors the
1521
https://stackoverflow.com/tags/spring-boot[`spring-boot`] tag on Stack Overflow. Before
1622
asking a question, please familiarize yourself with Stack Overflow's
1723
https://stackoverflow.com/help/how-to-ask[advice on how to ask a good question].
1824

25+
26+
1927
== Gitter
28+
2029
If you want to discuss something or have a question that isn't suited to Stack Overflow,
2130
the Spring Boot community chat in the
2231
https://gitter.im/spring-projects/spring-boot[#spring-boot room on Gitter].
2332

33+
34+
2435
== VMware Open Source Software Support
36+
2537
If you are interested in more dedicated support, VMware provides
2638
https://spring.io/support[premium support] for Spring Boot.

spring-boot-project/spring-boot-actuator/README.adoc

+17-11
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,37 @@ gathering can be automatically applied to your application. The
77
https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production-ready[user guide]
88
covers the features in more detail.
99

10+
11+
1012
== Enabling the Actuator
13+
1114
The recommended way to enable the features is to add a dependency to the
1215
`spring-boot-starter-actuator` '`Starter`'. To add the actuator to a Maven-based project,
1316
add the following '`Starter`' dependency:
1417

15-
[source,xml,indent=0]
18+
[source,xml]
1619
----
17-
<dependencies>
18-
<dependency>
19-
<groupId>org.springframework.boot</groupId>
20-
<artifactId>spring-boot-starter-actuator</artifactId>
21-
</dependency>
22-
</dependencies>
20+
<dependencies>
21+
<dependency>
22+
<groupId>org.springframework.boot</groupId>
23+
<artifactId>spring-boot-starter-actuator</artifactId>
24+
</dependency>
25+
</dependencies>
2326
----
2427

2528
For Gradle, use the following declaration:
2629

27-
[indent=0]
30+
[source]
2831
----
29-
dependencies {
30-
implementation 'org.springframework.boot:spring-boot-starter-actuator'
31-
}
32+
dependencies {
33+
implementation 'org.springframework.boot:spring-boot-starter-actuator'
34+
}
3235
----
3336

37+
38+
3439
== Features
40+
3541
* **Endpoints** Actuator endpoints allow you to monitor and interact with your
3642
application. Spring Boot includes a number of built-in endpoints and you can also add
3743
your own. For example the `health` endpoint provides basic application health

spring-boot-project/spring-boot-starters/README.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ For complete details see the
1111
https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter[reference documentation]
1212

1313
== Community Contributions
14+
1415
If you create a starter for a technology that is not already in the standard list we can
1516
list it here. To ask us to do so, please open a pull request that updates this page.
1617

0 commit comments

Comments
 (0)