Add screenshot to user-guide

This commit is contained in:
Dave Syer 2017-04-12 17:40:22 +01:00 committed by Stephane Nicoll
parent bb53c49a85
commit d18bee5057
3 changed files with 28 additions and 25 deletions

View File

@ -4,8 +4,9 @@
[partintro] [partintro]
-- --
This section describes how you can create your own instance of the service and tune it for This section describes how you can create your own instance of the service and tune it for
your needs. You'll also find some advanced tips to make sure the available options are your needs, and also how you can configure an existing instance. You'll also find some
consistent with the chosen Spring Boot generation. advanced tips to make sure the available options are consistent with the chosen Spring
Boot generation.
-- --
@ -108,14 +109,15 @@ These two packaging types are the only one explicitly supported at the moment.
[[create-instance-boot-versions]] [[create-instance-boot-versions]]
=== Configuring available Spring Boot versions === Configuring available Spring Boot versions
If you look at http://projects.spring.io/spring-boot[the project home page for Spring If you look at http://projects.spring.io/spring-boot[the project home page for Spring
Boot], the latest versions are displayed. And you've probably noticed that they match Boot], the latest versions are displayed. And you've probably noticed that they match the
the drop down list that you automatically get with a default instance. The reason for that drop down list that you automatically get with a default instance of the Initializr. The
is that Spring Initializr requests an API on spring.io to retrieve the latest versions reason for that is that Spring Initializr calls an API on spring.io to retrieve the
automatically. This makes sure that you always get the latest available versions. latest versions automatically. This makes sure that you always get the latest available
versions.
If that's not what you want, you need to override the `InitializrMetadataProvider` bean If that's not what you want, you need to override the `InitializrMetadataProvider` bean to
that is responsible to provide the metadata of the service. For instance, you could swap provide your own metadata for the service. For instance, you could swap to an
to an implementation that always returns the content of your configuration file: implementation that always returns the contents of your configuration file:
[source,java,indent=0] [source,java,indent=0]
---- ----
@ -141,7 +143,7 @@ The available project types mostly define the structure of the generated project
build system. Once a project type is selected, the related action is invoked to generate build system. Once a project type is selected, the related action is invoked to generate
the project. the project.
By default, Spring Initializr exposes the following actions: By default, Spring Initializr exposes the following resources (all accessed via HTTP GET):
* `/pom.xml` generate a Maven `pom.xml` * `/pom.xml` generate a Maven `pom.xml`
* `/build.gradle` generate a Gradle build * `/build.gradle` generate a Gradle build
@ -184,11 +186,11 @@ project:
action: /starter.zip action: /starter.zip
---- ----
NOTE: If you intend to build a custom client against your service, you can add as NOTE: If you intend to build a custom client against your service, you can add as many
many tags as you want. tags as you want, and process them in the client in a way that makes sense for your users.
The spring boot CLI uses them as a shortcut to the full id. So rather than having to For instance, the spring boot CLI uses them as a shortcut to the full type id. So rather
create a Gradle project as follows: than having to create a Gradle project as follows:
[indent=0,subs="verbatim,quotes,attributes"] [indent=0,subs="verbatim,quotes,attributes"]
---- ----

Binary file not shown.

After

Width:  |  Height:  |  Size: 248 KiB

View File

@ -20,7 +20,7 @@ arrow keys and `Enter` to select the "Web" starter.
Your browser should now be in this state: Your browser should now be in this state:
TODO: add screenshot image::web-selected.png[]
NOTE: The Spring Boot version above probably doesn't match the one you have. As we will NOTE: The Spring Boot version above probably doesn't match the one you have. As we will
see later, start.spring.io is continuously updated as new Spring Boot versions are see later, start.spring.io is continuously updated as new Spring Boot versions are
@ -58,9 +58,10 @@ Because Spring Initializr has detected it is a web application, a `static` and `
directories have been created to hold your static resources and ui templates. directories have been created to hold your static resources and ui templates.
Also, a Maven wrapper is automatically included so that you don't have to install Maven to Also, a Maven wrapper is automatically included so that you don't have to install Maven to
run this project. You can select Gradle instead in first drop down list. This will run this project (you can build it with `./mvnw install`). If you prefer, you can select
generate a Gradle-based project instead that also contains a wrapper if you don't have Gradle instead in the first drop down list at the top of the screen. This will generate a
Gradle installed. Gradle-based project instead that also contains a wrapper if you don't have Gradle
installed (build it with `./gradlew build`).
@ -85,9 +86,9 @@ Maven). start.spring.io can generate jar or war projects
* *Language*: the programming language to use * *Language*: the programming language to use
If you keep on scrolling, you'll discover all the dependencies that you can find using the If you keep on scrolling, you'll discover all the dependencies that you can find using the
search box on the right. You'll probably notice that some dependencies aren't available search box on the right. You'll probably notice that some dependencies are greyed out in
because they require a specific Spring Boot version. We'll tackle that in the next the UI, meaning that they aren't available because they require a specific Spring Boot
section. version. We'll tackle that in the next section.
@ -95,9 +96,9 @@ section.
=== Dependencies === Dependencies
The UI allows you to select the Spring Boot version you want to use. You may want to be The UI allows you to select the Spring Boot version you want to use. You may want to be
conservative and keep the default which corresponds at all times to the latest stable conservative and keep the default which corresponds at all times to the latest stable
release. Or you may want to chose a milestone of the next major version. Either way, release. Or you may want to chose a milestone or snapshot of the next major
you'll notice that certain dependencies become available and others aren't anymore when version. Either way, you'll notice that certain dependencies become available and others
you change the version. aren't anymore when you change the version.
If you are searching for a dependency that you know to be available and you get no result, If you are searching for a dependency that you know to be available and you get no result,
it's worth looking in the advanced section if that dependency is available in the Spring it's worth looking in the advanced section if that dependency is available in the Spring
@ -189,7 +190,7 @@ with the web UI:
* The project will be extracted in the current directory (the web UI adds a base directory * The project will be extracted in the current directory (the web UI adds a base directory
automatically with the same name as the one of the project) automatically with the same name as the one of the project)
* The name of the project is not `my-project` (the `-o` parameter has no incidence on the * The name of the project is not `my-project` (the `-o` parameter has no impact on the
name of the project) name of the project)
The exact same project can be generated using the `http` command as well: The exact same project can be generated using the `http` command as well: