Editing getting started #10763
Editing getting started #10763
Conversation
spring-projects-issues
added
the
status: waiting-for-triage
| any special tools integration, so you can use any IDE or text editor; and there is | ||
| nothing special about a Spring Boot application, so you can run and debug as you would | ||
| any special tools integration, so you can use any IDE or text editor. Also, there is | ||
| nothing special about a Spring Boot application, so you can run and debug a Spring Boot program as you would |
There was a problem hiding this comment.
The switch from "application" to "program" reads a little strangely to me. For consistency, shouldn't it be "application" again?
There was a problem hiding this comment.
"program" matches "any other Java program". That's the selling point in the sentence, so I thought it best to match "program".
There was a problem hiding this comment.
Got you. I still think it should be "application". A Spring Boot application is a particular type of Java program. I haven't heard of anyone refer to a Spring Boot program before. Application also ties in with the @SpringBootApplication annotation that pretty much every Boot app uses.
There was a problem hiding this comment.
OK. I'll put it back to application.
| The Spring Boot CLI is a command line tool that can be used if you want to quickly | ||
| prototype with Spring. It allows you to run http://groovy-lang.org/[Groovy] scripts, | ||
| which means that you have a familiar Java-like syntax, without so much boilerplate code. | ||
| The Spring Boot CLI (Command Line Interface) is a command line tool that you can use to quickly |
There was a problem hiding this comment.
What's the policy for expanding CLI to Command Line Interface? It was already done above but then isn't done below. I'm just curious so that we can follow the convention in the future.
There was a problem hiding this comment.
The policy is to define it the first time it's used and then periodically throughout the document. I did define it at the first instance in the document (currently line 77). Given that the term appears in the heading here, I thought defining it here too would be a good idea.
| initialization. On a Debian system, the system-wide scripts are in `/shell-completion/bash` | ||
| and all scripts in that directory are executed when a new shell starts. To run the script | ||
| manually, e.g. if you have installed using SDKMAN! | ||
| manually if you have installed using SDKMAN!, use the following commands: |
There was a problem hiding this comment.
I think SDKMAN! needs to be an example here. There are others reasons why you may want to install the script manually, not just if you installed the CLI with SDKMAN!
| `spring-boot-starter-parent` POM, you have a useful `run` goal that you can use to start | ||
| the application. Type `mvn spring-boot:run` from the root project directory to start the | ||
| application: | ||
| application. You should output similar to the following: |
There was a problem hiding this comment.
Missing "see"? You should output -> You should see output
There was a problem hiding this comment.
Oops. That's why I need reviewers as much as anyone else does. Thanks for catching it.
| all classes, from all jars, into a single archive. The problem with this approach is that | ||
| it becomes hard to see which libraries you are actually using in your application. It can | ||
| To solve this problem, many developers use "`uber`" jars. An uber jar packages | ||
| all the classes from all the contained jars into a single archive. The problem with this approach is that |
There was a problem hiding this comment.
Contained isn't quite right here. Perhaps just "all the jars" or, more accurately, "all the application's dependencies' jars"
There was a problem hiding this comment.
I find possessives of possessives to be hard to follow, so I changed the sentence to "An uber jar packages all the classes from all the application's dependencies into a single archive."
Does that work for you?
I made it more formal and fixed sentence errors. Then I also incorporated Andy Wilkinson's feedback. Andy caught a typo for me and had some other good ideas. I incorporated his input or, in a couple cases, stuck to and explained my original editing. Per a discussion with Andy Wilkinson, I changed "program" to "application" (the original word) at line 87.
wilkinsona
added
priority: normal
type: documentation
* gh-10763: Wrap getting-started.adoc at 90 characters Editorial changes to Getting Started documentation
3 participants
I made the document more formal and corrected sentence errors.