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

Polish docs

Browse Source
This commit is contained in:
Phillip Webb
2021-05-05 23:41:52 -07:00
parent aeea15be0f
commit d3207b107c
31 changed files with 92 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started/first-application.adoc
View File

@@ -59,18 +59,6 @@ Open your favorite text editor and add the following:
<version>{spring-boot-version}</version>
</parent>
<description/>
<developers>
<developer/>
</developers>
<licenses>
<license/>
</licenses>
<scm>
<url/>
</scm>
<url/>
<!-- Additional lines to be added here... -->
ifeval::["{spring-boot-artifactory-repo}" != "release"]
@@ -161,7 +149,7 @@ We step through the important parts in the next few sections.
[[getting-started.first-application.code.mvc-annotations]]
==== The @RestController and @RequestMapping Annotations
The first annotation on our `Example` class is `@RestController`.
The first annotation on our `MyApplication` class is `@RestController`.
This is known as a _stereotype_ annotation.
It provides hints for people reading the code and for Spring that the class plays a specific role.
In this case, our class is a web `@Controller`, so Spring considers it when handling incoming web requests.
@@ -196,7 +184,7 @@ The final part of our application is the `main` method.
This is a standard method that follows the Java convention for an application entry point.
Our main method delegates to Spring Boot's `SpringApplication` class by calling `run`.
`SpringApplication` bootstraps our application, starting Spring, which, in turn, starts the auto-configured Tomcat web server.
We need to pass `Example.class` as an argument to the `run` method to tell `SpringApplication` which is the primary Spring component.
We need to pass `MyApplication.class` as an argument to the `run` method to tell `SpringApplication` which is the primary Spring component.
The `args` array is also passed through to expose any command-line arguments.

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started/installing.adoc
View File

@@ -68,7 +68,7 @@ More details on getting started with Spring Boot and Gradle can be found in the
The Spring Boot CLI (Command Line Interface) is a command line tool that you can use to quickly prototype with Spring.
It lets you run https://groovy-lang.org/[Groovy] scripts, which means that you have a familiar Java-like syntax without so much boilerplate code.
You do not need to use the CLI to work with Spring Boot, but it is definitely the quickest way to get a Spring application off the ground.
You do not need to use the CLI to work with Spring Boot, but it is a quick way to get a Spring application off the ground without an IDE.

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started/introducing-spring-boot.adoc
View File

@@ -1,6 +1,6 @@
[[getting-started.introducing-spring-boot]]
== Introducing Spring Boot
Spring Boot helps you to create stand-alone, production-grade Spring-based Applications that you can run.
Spring Boot helps you to create stand-alone, production-grade Spring-based applications that you can run.
We take an opinionated view of the Spring platform and third-party libraries, so that you can get started with minimum fuss.
Most Spring Boot applications need very little Spring configuration.

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started/system-requirements.adoc
View File

@@ -1,6 +1,6 @@
[[getting-started.system-requirements]]
== System Requirements
Spring Boot {spring-boot-version} requires https://www.java.com[Java 8] and is compatible up to Java 16 (included).
Spring Boot {spring-boot-version} requires https://www.java.com[Java 8] and is compatible up to and including Java 16.
{spring-framework-docs}/[Spring Framework {spring-framework-version}] or above is also required.
Explicit build support is provided for the following build tools: