Skip to content

Commit 01a8871

Browse files
Getting started updates (helidon-io#448)
* - Remove examples/guides - Combine about and getting started nav groups - Move quickstarts under guide - Update links to quickstarts * remove comment-out block in pre-reqs, break line for 80 chars * Update getting started guides * rename docker guide to be all lower case * split jib and docker guides, minor update to all guides for consistency * remove getting start card from top level overview
1 parent 486025e commit 01a8871

36 files changed

Lines changed: 583 additions & 3130 deletions

File tree

docs/src/main/docs/about/01_overview.adoc

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,6 @@
2424
2525
[PILLARS]
2626
====
27-
[CARD]
28-
.Getting Started
29-
[icon=assistant,link=getting-started/02_base-example.adoc]
30-
--
31-
Quickly create your first application, in under 2 minutes.
32-
--
33-
3427
[CARD]
3528
.Guides
3629
[icon=explore,link=guides/01_overview.adoc]

docs/src/main/docs/getting-started/01_prerequisites.adoc renamed to docs/src/main/docs/about/03_prerequisites.adoc

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
///////////////////////////////////////////////////////////////////////////////
22

3-
Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
3+
Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
44

55
Licensed under the Apache License, Version 2.0 (the "License");
66
you may not use this file except in compliance with the License.
@@ -31,7 +31,6 @@ deploy to Kubernetes, you need `kubectl` and a Kubernetes cluster (you can
3131
3232
The following list shows the minimum versions.
3333
34-
//[role="flex, sm7, md6, lg5"]
3534
[role="flex, sm7"]
3635
|=======
3736
|https://www.oracle.com/technetwork/java/javase/downloads[Java{nbsp}SE{nbsp}8] or http://jdk.java.net[Open{nbsp}JDK{nbsp}8] | {nbsp}
@@ -63,27 +62,7 @@ export JAVA_HOME=`/usr/libexec/java_home -v 1.8`
6362
export JAVA_HOME=/usr/lib/jvm/jdk-8
6463
----
6564
66-
/////////////////////////////////////////////////////////////////////////////
67-
Since we are using docker build, these don't need to be set
68-
== Setting MAVEN_OPTS
69-
70-
The base example used throughout the documentation supports building docker images
71-
using Maven. In order for this to work with Java 9 you must set some options.
72-
Note that these options only work with Java 9. If you do not plan on generating a docker
73-
image then you can skip this section.
74-
75-
[source,bash]
76-
.Setting `MAVEN_OPTS`
77-
----
78-
export MAVEN_OPTS="--add-modules java.xml.bind \
79-
--add-opens java.base/java.lang=ALL-UNNAMED \
80-
--add-opens java.xml.bind/javax.xml.bind=ALL-UNNAMED \
81-
--add-opens java.activation/javax.activation=ALL-UNNAMED \
82-
-Xmx1024M"
83-
----
84-
/////////////////////////////////////////////////////////////////////////////
85-
8665
== Try the Quickstart Examples
8766
8867
Now you are ready to try the
89-
<<getting-started/02_base-example.adoc#Prerequisites,Quickstart Examples>>.
68+
<<guides/01_overview.adoc#_getting_started,Quickstart Examples>>.

docs/src/main/docs/getting-started/03_managing-dependencies.adoc renamed to docs/src/main/docs/about/04_managing-dependencies.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
///////////////////////////////////////////////////////////////////////////////
22

3-
Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
3+
Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
44

55
Licensed under the Apache License, Version 2.0 (the "License");
66
you may not use this file except in compliance with the License.
@@ -23,12 +23,13 @@
2323
Helidon provides a "`Bill Of Materials`" (BOM) to manage dependencies.
2424
This is a special Maven pom file that provides dependency management.
2525
26-
Using the Helidon BOM allows you to use Helidon component dependencies with a single
27-
version: the Helidon version.
26+
Using the Helidon BOM allows you to use Helidon component dependencies with a
27+
single version: the Helidon version.
2828
2929
== The Helidon BOM POM
3030
31-
Add the following snippet to your pom.xml file in order to import the Helidon BOM.
31+
Add the following snippet to your pom.xml file in order to import the Helidon
32+
BOM.
3233
3334
[source,xml,subs="attributes+"]
3435
.Import the Helidon BOM
@@ -48,8 +49,8 @@ Add the following snippet to your pom.xml file in order to import the Helidon BO
4849
4950
== Using Helidon Component Dependencies
5051
51-
Once you have imported the BOM, you can declare dependencies on Helidon components
52-
without specifying a version.
52+
Once you have imported the BOM, you can declare dependencies on Helidon
53+
components without specifying a version.
5354
5455
[source,xml]
5556
.Component dependency

docs/src/main/docs/getting-started/04_kubernetes.adoc renamed to docs/src/main/docs/about/05_kubernetes.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
///////////////////////////////////////////////////////////////////////////////
22

3-
Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
3+
Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
44

55
Licensed under the Apache License, Version 2.0 (the "License");
66
you may not use this file except in compliance with the License.
@@ -24,7 +24,8 @@ For development it's often convenient to run Kubernetes on your desktop.
2424
Two popular ways to do this are with
2525
https://kubernetes.io/docs/getting-started-guides/minikube/[Kubernetes Minikube]
2626
or
27-
https://docs.docker.com/docker-for-mac/kubernetes/[Kubernetes support in Docker for Desktop].
27+
https://docs.docker.com/docker-for-mac/kubernetes/[Kubernetes support in Docker
28+
for Desktop].
2829
2930
In this guide we'll use Docker for Desktop.
3031
@@ -41,7 +42,8 @@ To use the Kubernetes support you'll want to get the Edge Channel installer.
4142
Enable
4243
https://docs.docker.com/docker-for-mac/#kubernetes[Kubernetes Support for Mac]
4344
or
44-
https://docs.docker.com/docker-for-windows/#kubernetes[Kubernetes Support for Windows].
45+
https://docs.docker.com/docker-for-windows/#kubernetes[Kubernetes Support for
46+
Windows].
4547
4648
Once Kubernetes installation is complete, make sure you have your context
4749
set correctly to use docker-for-desktop.
@@ -55,5 +57,3 @@ kubectl cluster-info
5557
kubectl version --short
5658
kubectl get nodes
5759
----
58-
59-
== Continue with <<getting-started/02_base-example.adoc#deploy-to-k8s,the quickstart example>>

docs/src/main/docs/guides/01_overview.adoc

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,26 @@
1616

1717
///////////////////////////////////////////////////////////////////////////////
1818
19-
= Guides Overview
19+
= Overview
2020
:description: Helidon guides
2121
:keywords: helidon, java, microservices, microprofile, guides
2222
23-
== Basics
23+
== Getting Started
2424
2525
[PILLARS]
2626
====
2727
[CARD]
28-
.SE REST Web Service
29-
[link=guides/02_SE_REST_web-service.adoc]
28+
.Quickstart SE
29+
[link=guides/02_quickstart-se.adoc]
3030
--
31-
Use Helidon SE to create a RESTful web service that accepts HTTP requests.
31+
Quickly create your first Helidon SE application in under 5 minutes.
3232
--
3333
3434
[CARD]
35-
.MP REST Web Service
36-
[link=guides/03_MP_REST_web-service.adoc]
35+
.Quickstart MP
36+
[link=guides/03_quickstart-mp.adoc]
3737
--
38-
Use Helidon MP to create a JAX-RS RESTful web service.
38+
Quickly create your first Helidon MP application in under 5 minutes.
3939
--
4040
====
4141
@@ -45,8 +45,16 @@ Use Helidon MP to create a JAX-RS RESTful web service.
4545
====
4646
[CARD]
4747
.Create Docker Images
48-
[link=guides/05_Dockerfile.adoc]
48+
[link=guides/04_dockerfile.adoc]
4949
--
50-
Package your application and the necessary runtime dependencies as a Docker image that also contains the Java runtime.
50+
Learn how to package your application and the necessary runtime dependencies as
51+
a Docker image.
52+
--
53+
54+
[CARD]
55+
.Build Container Images with Jib
56+
[link=guides/05_jib.adoc]
57+
--
58+
Learn how to use Jib to create a container image without Docker.
5159
--
5260
====

docs/src/main/docs/guides/02_SE_REST_web-service.adoc

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)