Skip to content

Commit

Permalink
Merge pull request #120 from tjquinno/show-guides-on-site
Browse files Browse the repository at this point in the history
Update site to display and navigate to the guides
  • Loading branch information
tjquinno authored Oct 18, 2018
2 parents 773dc91 + 686d320 commit dba6b8f
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 42 deletions.
41 changes: 4 additions & 37 deletions docs/src/main/docs/guides/01_SE_REST_web-service.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,42 +21,9 @@
= Creating a ReSTful Web Service using Helidon SE
:description: Helidon SE ReSTful Web Service Guide
:keywords: helidon, guide, rest, web, service
:description: Helidon guide restful web service
:keywords: helidon, guide, rest, web, service, example
This guide takes you through creating, building, and running a simple ReSTful web service using Helidon SE.
Create and build a ReSTful web service as your first Helidon SE application.
image:guides/baseline-schedule-24px.svg["Duration", title="Duration"] 15 minutes
== What You'll Learn
You will learn how to write a simple ReSTful web service using Helidon SE and its
reactive web server and how to build and run it using Maven.
== What You'll Need
* A text editor or an IDE
* JDK 1.8 or later
* Maven 3.5 or later
== Creating the Application
You have two choices:
* <<do-it-yourself,Do-it-yourself>> - Create a new maven project and add the code to it yourself.
* <<outsource-it,Outsource it>> - Clone a github repository or download a zip containing the finished example.
Either way you'll follow the same steps to build and run the application.
=== Do-it-yourself [[do-it-yourself]]
[source,java]
----
include::https://github.com/oracle/helidon/blob/master/examples/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/Main.java
----
=== Outsource It [[outsource-it]]
== Building the Project
== Running the Application
include::{guides-dir}/se-restful-webservice/src/main/docs/index.adoc[]
9 changes: 9 additions & 0 deletions docs/src/main/docs/sitegen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ engine:
plantumlconfig: "_plantuml-config.txt"
javadoc-base-url: "./apidocs/index.html"
helidon-version: "${project.version}"
guides-dir: "${project.basedir}/../examples/guides"
assets:
- target: "/"
includes:
Expand Down Expand Up @@ -100,6 +101,14 @@ backend:
items:
- includes:
- "microprofile/*.adoc"
- title: "Guides"
pathprefix: "/guides"
glyph:
type: "icon"
value: "explore"
items:
- includes:
- "guides/*.adoc"
- title: "Javadocs"
glyph:
type: "icon"
Expand Down
2 changes: 1 addition & 1 deletion examples/guides/se-restful-webservice/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
<type>pom</type>
<scope>import</scope>
</dependency>
<!-- end::depMgt[] -->
<!-- end::depMgt[] -->
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,18 @@
limitations under the License.

///////////////////////////////////////////////////////////////////////////////
:java-base: ../java/io/helidon/guides/se/restfulwebservice
:adoc-dir: {guides-dir}/se-restful-webservice/src/main/docs
:java-base: {adoc-dir}/../java/io/helidon/guides/se/restfulwebservice
:greet-service: {java-base}/GreetService.java
:main-class: {java-base}/Main.java
:pom: ../../pom.xml
:pom: {adoc-dir}/../../../pom.xml
= The ReSTful Web Service Guide
:description: Helidon guide restful web service
:keywords: helidon, guide, example
Create and build a ReSTful web service as your first Helidon application.
Create and build a ReSTful web service as your first Helidon SE application.
== What You Will Learn
You'll learn how to use Helidon quickly to create a ReSTful web service that accepts these HTTP requests:
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
<version.plugin.resources>2.7</version.plugin.resources>
<version.plugin.scm-publish-plugin>3.0.0</version.plugin.scm-publish-plugin>
<version.plugin.site>3.7.1</version.plugin.site>
<version.plugin.sitegen>1.0.0</version.plugin.sitegen>
<version.plugin.sitegen>1.0.3</version.plugin.sitegen>
<version.plugin.source>3.0.1</version.plugin.source>
<version.plugin.spotbugs>3.1.3.1</version.plugin.spotbugs>
<version.plugin.spotify-docker>1.0.0</version.plugin.spotify-docker>
Expand Down

0 comments on commit dba6b8f

Please sign in to comment.