Editing pass for using-spring-boot.adoc #10765
Conversation
spring-projects-issues
added
the
status: waiting-for-triage
| * A <<using-boot-dependency-management,Dependency Management section>>, allowing you to | ||
| omit `<version>` tags for common dependencies, inherited from the | ||
| * A <<using-boot-dependency-management,Dependency Management section>> that lets you | ||
| omit `<version>` tags for common dependencies that are inherited from the |
There was a problem hiding this comment.
The meaning's wrong now. It's the dependency management that's inherited rather than the common dependencies
There was a problem hiding this comment.
I'm not following this sentence. I suspect it needs to be two or perhaps three sentences, but I don't know what they should be. Can you rephrase them?
There was a problem hiding this comment.
I can try. How about something like this:
A dependency management section, inherited from the spring-boot-dependencies pom, that manages the versions of common dependencies. This dependency management allows you to omit <version> tags for those dependencies when used in your own pom.
| Spring style placeholders (`${...}`) the Maven filtering is changed to | ||
| use `@..@` placeholders (you can override that with a Maven property | ||
| `resource.delimiter`). | ||
| On the last point: Note that, since the default config files accept |
There was a problem hiding this comment.
Should this be note rather than Note?
| entry. For instance, to upgrade to another Spring Data release train you'd add the | ||
| following to your `pom.xml`. | ||
| entry. For instance, to upgrade to another Spring Data release train, you could add the | ||
| following to your `pom.xml`, as follows: |
There was a problem hiding this comment.
IMO, following … as follows doesn't read very nicely
| NOTE: If you use the Spring Boot starter parent pom, you only need to add the plugin, | ||
| there is no need for to configure it unless you want to change the settings defined in | ||
| NOTE: If you use the Spring Boot starter parent pom, you need to add only the plugin. | ||
| There is no need for to configure it unless you want to change the settings defined in |
There was a problem hiding this comment.
There's an extra "for" here. Not your doing, but thought I'd mention it as I noticed it during this review.
| As explained in the <<spring-boot-features#boot-features-custom-starter,Creating Your Own Starter>> | ||
| section, third party starters should not start with `spring-boot`, as it is reserved for | ||
| official Spring Boot artifacts. Rather, a third-party starter typically starts with the | ||
| name of the organization that made it. For example, a third-party starter from `acme` |
There was a problem hiding this comment.
It's not the name of the organisation but the name of the project. Perhaps "acme" isn't an ideal example name as it does suggest that it's an organisation rather than a project.
There was a problem hiding this comment.
OK. I changed "acme" to "thirdpartyproject". Wile E. Coyote will be disappointed. ;)
| If you find that specific auto-configure classes are being applied that you don't want, | ||
| you can use the exclude attribute of `@EnableAutoConfiguration` to disable them. | ||
| === Disabling Specific Auto-configuration Classes | ||
| If you find that specific auto-configure classes that you do not want are being applied, |
There was a problem hiding this comment.
Not your doing but I think this should be "auto-configuration" rather than "auto-configure"
There was a problem hiding this comment.
Good catch, but I think the better fix is to change "auto-configure" to "auto-configuration" in the first sentence. "auto-configure" should be a verb (that gets fuzzy in a hurry, though), while "auto-configuration should be the noun and adjective. So it's a smidgeon more correct to write, "auto-configuration."
|
|
||
| Remote devtools support is provided in two parts; there is a server side endpoint that | ||
| accepts connections, and a client application that you run in your IDE. The server | ||
| Remote devtools support is provided in two parts: a server_side endpoint that |
| ==== Running the Remote Client Application | ||
| The remote client application is designed to be run from within your IDE. You need to run | ||
| `org.springframework.boot.devtools.RemoteSpringApplication` using the same classpath as | ||
| the remote project that you're connecting to. The _non-option_ argument passed to the |
There was a problem hiding this comment.
I think non-option was right here. It's the difference between whatever and --whatever. Perhaps there's a better way to describe that?
There was a problem hiding this comment.
I changed the sentence to describe the single required argument. It now reads, "The application's single required argument is the remote URL to which it connects."
I made it more formal and corrected sentence errors.
With one exception, I incorporated Andy's feedback. The exception is a bullet point that I think needs to be rewritten. I'm not following it. Hopefully, Andy can explain it to me, and then I can make a sensible explanation in the document.
I asked Andy to rewrite a bullet point that confused me. He did so, and I have made the change in the file. Thanks, Andy.
wilkinsona
added
priority: normal
type: documentation
3 participants
I made the document more formal and corrected sentence errors.