Skip to content

Proposal for a full tooling guide #1177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 4, 2019
Merged

Proposal for a full tooling guide #1177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a596558
Issue 1156 - Rename ide-configuration guide into tooling guide
emmanuelbernard Mar 4, 2019
88b7f15
Issue 1156 - Rework the ide-configuration guide into a full tooling g…
emmanuelbernard Mar 4, 2019
1744b08
Fix a few typos
gsmet Mar 4, 2019
032ae77
Address Clement's comments
gsmet Mar 4, 2019
607b44d
Re-add versions used in the documentation to the build-parent pom
gsmet Mar 4, 2019
9ba3b3f
graal-version should be graalvm-version to be consistent with the README
gsmet Mar 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions bom/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,6 @@
<!-- What we actually depend on for the annotations, as latest Graal
is not available in Maven fast enough: -->
<graal-sdk.version>1.0.0-rc12</graal-sdk.version>
<!-- The Graal version we suggest using in documentation - as that's
what we work with by self downloading it: -->
<graal-sdk.version-for-documentation>1.0.0-rc12</graal-sdk.version-for-documentation>
<gizmo.version>1.0.0.Alpha1</gizmo.version>
<jackson.version>2.9.8</jackson.version>
<commons-beanutils-core.version>1.8.3</commons-beanutils-core.version>
Expand Down
6 changes: 6 additions & 0 deletions build-parent/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@
<!-- These properties are needed in order for them to be resolvable by the generated projects -->
<kotlin.version>1.3.21</kotlin.version>

<!-- These properties are needed in order for them to be resolvable by the documentation -->
<!-- The Graal version we suggest using in documentation - as that's
what we work with by self downloading it: -->
<graal-sdk.version-for-documentation>1.0.0-rc12</graal-sdk.version-for-documentation>
<rest-assured.version>3.3.0</rest-assured.version>

<!-- Enable APT by default for Eclipse -->
<m2e.apt.activation>jdt_apt</m2e.apt.activation>
</properties>
Expand Down
2 changes: 1 addition & 1 deletion docs/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<attributes>
<quarkus-version>${project.version}</quarkus-version>
<surefire-version>${version.surefire.plugin}</surefire-version>
<graal-version>${graal-sdk.version-for-documentation}</graal-version>
<graalvm-version>${graal-sdk.version-for-documentation}</graalvm-version>
<restassured-version>${rest-assured.version}</restassured-version>
<project-name>Quarkus</project-name>
<!-- Project website home page -->
Expand Down
1 change: 1 addition & 0 deletions docs/src/main/asciidoc/README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,5 @@ complete list of externalized variables for use is given in the following table:
|\{quickstarts-blob-url}|{quickstarts-blob-url}| Quickstarts URL to master blob source tree; used for referencing source files.
|\{quickstarts-tree-url}|{quickstarts-tree-url}| Quickstarts URL to master source tree root; used for referencing directories.

|\{graalvm-version}|{graalvm-version}| Recommended Graal VM version to use.
|===
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/building-native-image-guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To complete this guide, you need:
* JDK 1.8+ installed with `JAVA_HOME` configured appropriately
* GraalVM installed from the http://www.graalvm.org/downloads/[GraalVM web site].
Using the community edition is enough.
At least version {graal-version} is required.
At least version {graalvm-version} is required.
* The `GRAALVM_HOME` environment variable configured appropriately
* Apache Maven 3.5.3+
* A running Docker
Expand Down
3 changes: 2 additions & 1 deletion docs/src/main/asciidoc/getting-started-guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,9 +415,10 @@ This guide covered the creation of an application using Quarkus.
However, there is much more.
We recommend continuing the journey with the link:building-native-image-guide.html[building a native image guide], where you learn about the native executable creation and the packaging in a container.

In addition, the link:ide-configuration.html[developer guide] document explains how to:
In addition, the link:tooling.html[tooling guide] document explains how to:

* scaffold a project in a single command line,
* enable the _development model_ (hot reload)
* import the project in your favorite IDE
* and more

132 changes: 0 additions & 132 deletions docs/src/main/asciidoc/ide-configuration.adoc
View file
Open in desktop

This file was deleted.

5 changes: 3 additions & 2 deletions docs/src/main/asciidoc/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ include::quarkus-intro.adoc[tag=intro]
* link:building-native-image-guide.html[Building Native Image]
* link:kubernetes-guide.html[Deploy Application on Kubernetes]
* link:getting-started-knative-guide.html[Deploy as Knative Application on Kubernetes]
* link:ide-configuration.html[Project Scaffolding and IDE]
* link:tooling.html[Project Scaffolding and IDE]

== Other guides

* link:tooling.html[Use tooling with Quarkus]
* link:application-configuration-guide.html[Configuring Your Application]
* link:logging-guide.html[Configuring Logging]
* link:application-lifecycle-events-guide.html[Application Initialization and Termination]
Expand Down Expand Up @@ -45,7 +46,7 @@ _Mandatory:_
_Recommended:_

* https://docs.docker.com/install/[Docker]
* http://www.graalvm.org/docs/getting-started/[GraalVM {graal-version}]
* http://www.graalvm.org/docs/getting-started/[GraalVM {graalvm-version}]


== Feedback, looking for help?
Expand Down
Loading