Skip to content
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.

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

Latest sitegen and functional docs improvements #4463

Merged
merged 42 commits into from
Jul 6, 2022
Merged
Show file tree
Hide file tree
Changes from 37 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
0101d83
save work
romain-grecourt Jun 28, 2022
6792a5d
save work
romain-grecourt Jun 28, 2022
397a5ce
save work
romain-grecourt Jun 29, 2022
65fb0c0
save work
romain-grecourt Jun 29, 2022
869e9ba
fix copyrights
romain-grecourt Jun 29, 2022
7853f0c
save work
romain-grecourt Jun 29, 2022
c986143
save work
romain-grecourt Jun 30, 2022
f1b3c3f
Merge commit '2bbcb32c04de066da5cbd0f37e22dbb4a8314e96' into doc-updates
romain-grecourt Jun 30, 2022
4b6c6eb
Merge commit '7fefb4effb4b98e5e3d0cfb85e1e5482666b3620' into doc-updates
romain-grecourt Jun 30, 2022
89fa430
Merge commit '31f8e1b2e147e6d98f72a0745da5d031aa231e44' into doc-updates
romain-grecourt Jun 30, 2022
f2ac10e
update jaxrs-client.adoc
romain-grecourt Jun 30, 2022
02e8929
Merge commit '8171f565d784ecaf51bb849a6a435d1f1c06aad4' into doc-updates
romain-grecourt Jun 30, 2022
9ca6d66
Merge commit '6f4caa02c7add384315396cf865ef52469c9bd16' into doc-updates
romain-grecourt Jun 30, 2022
69d5c09
Merge commit 'ab8d9e22038c4c23619587fdb35652fb002dbdd6' into doc-updates
romain-grecourt Jun 30, 2022
a4effbd
Merge commit '8e48221ef03438afc898d9f263bcb60130882b83' into doc-updates
romain-grecourt Jun 30, 2022
60228e8
Merge commit '4e7b4ab9527cd4dc582a03dc7b6529a9ce5f40a6' into doc-updates
romain-grecourt Jun 30, 2022
62496d9
Merge commit '3f255eedfbe7736a8d54dccb69c54a079ab238b3' into doc-updates
romain-grecourt Jun 30, 2022
57050e3
Merge commit 'd88430b9a40a25b55aa3fb0e0d96038f9259bffe' into doc-updates
romain-grecourt Jun 30, 2022
627642e
update helidon javadoc-base-url attributes
romain-grecourt Jun 30, 2022
6662dcd
Merge commit '9f0eabdd65c28910f0a74c24f2862a46b726338a' into doc-updates
romain-grecourt Jul 1, 2022
473c2af
Merge commit 'da76f6b3b15e55e95c2e28d231d2957fba4e2182' into doc-updates
romain-grecourt Jul 1, 2022
2719678
Merge commit '2e68bf4bd2931d3f41a20ad424e8781f6ae4a414' into doc-updates
romain-grecourt Jul 1, 2022
250ce3e
Merge commit '0bb3bacd95a86122ce7ae3a9c1679b8e4ffe61ad' into doc-updates
romain-grecourt Jul 1, 2022
4e7078d
Merge commit '4adaf5c356b19094bd9ed5f52f58809b2875e40f' into doc-updates
romain-grecourt Jul 1, 2022
c60c4af
Merge commit 'ad4904dc0d32fde2701194459adff7b9fa770462' into doc-updates
romain-grecourt Jul 1, 2022
594bb40
Merge commit 'd384896ca7b73fa22ab93f17a700cc607eae1281' into doc-updates
romain-grecourt Jul 1, 2022
6784ff3
Merge commit '89c4bcb5f2e4d01dddfc1d67e55fe8e073850e71' into doc-updates
romain-grecourt Jul 1, 2022
14e8a87
Merge remote-tracking branch 'origin/master' into doc-updates
romain-grecourt Jul 1, 2022
7e160ce
Fix missing feature-name attribute
romain-grecourt Jul 1, 2022
b57dd14
Update websocket feature-name
romain-grecourt Jul 1, 2022
1a3325f
Merge remote-tracking branch 'origin/master' into doc-updates
romain-grecourt Jul 1, 2022
93ed3af
Update dbclient guide
romain-grecourt Jul 1, 2022
bf7b5a1
Merge remote-tracking branch 'origin/master' into doc-updates
romain-grecourt Jul 1, 2022
839a2d3
Update SE fault tolerance
romain-grecourt Jul 1, 2022
a9aaee0
integrate build-tools 3.0.0-M4
romain-grecourt Jul 1, 2022
a5f362a
fix archetypes to work with latest build tools
romain-grecourt Jul 1, 2022
d139283
Merge remote-tracking branch 'origin/master' into doc-updates
romain-grecourt Jul 1, 2022
3c524c0
fix legacy archetypes
romain-grecourt Jul 2, 2022
fb46a13
Merge remote-tracking branch 'origin/master' into doc-updates
romain-grecourt Jul 6, 2022
db34532
Update se/cors.
romain-grecourt Jul 6, 2022
8e4ec9f
integrate 3.0.0-M5, enable ossrh-staging temporarily
romain-grecourt Jul 6, 2022
ca76354
remove activation of ossrh-staging profile
romain-grecourt Jul 6, 2022
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,4 @@ ObjectStore/
PutObjectStoreDirHere/
package-lock.json
RUNTIMEDB/
docs/se/config/images
6 changes: 3 additions & 3 deletions archetypes/helidon/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@
<artifactId>helidon-archetype-maven-plugin</artifactId>
<configuration>
<entrypoint>
<presets>
<text path="helidon-version" resolvable="false">${project.version}</text>
</presets>
<variables>
<text path="helidon-version" transient="true">${project.version}</text>
</variables>
<exec src="flavor.xml"/>
</entrypoint>
</configuration>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://helidon.io/archetype/2.0 https://helidon.io/xsd/archetype-2.0.xsd">

<step label="Customize Project">
<step name="Customize Project" optional="true">
<inputs>
<enum name="build-system" label="Select a build system" default="maven">
<option value="maven" label="Apache Maven">
<enum id="build-system" name="Select a Build System" default="maven" optional="true">
<option value="maven" name="Apache Maven">
<output>
<templates engine="mustache" transformations="mustache">
<directory>files</directory>
Expand All @@ -34,10 +34,10 @@
</output>
</option>
</enum>
<text name="groupId" label="Project groupId" optional="true" default="com.examples"/>
<text name="artifactId" label="Project artifactId" optional="true" default="myproject"/>
<text name="version" label="Project version" optional="true" default="1.0-SNAPSHOT"/>
<text name="package" label="Java package name" optional="true" default="com.example.myproject"/>
<text id="groupId" name="Project groupId" optional="true" default="com.examples"/>
<text id="artifactId" name="Project artifactId" optional="true" default="myproject"/>
<text id="version" name="Project version" optional="true" default="1.0-SNAPSHOT"/>
<text id="package" name="Java package name" optional="true" default="com.example.myproject"/>
</inputs>
<output>
<model>
Expand Down
81 changes: 42 additions & 39 deletions archetypes/helidon/src/main/archetype/common/docker.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,48 +20,51 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://helidon.io/archetype/2.0 https://helidon.io/xsd/archetype-2.0.xsd">

<step label="Docker">
<inputs>
<boolean name="docker" label="Docker support" prompt="Do you want a Dockerfile ?">
<inputs>
<boolean name="native-image" label="Do you want a native-image Dockerfile ?"/>
<boolean name="jlink" label="Do you want a jlink Dockerfile ?"/>
</inputs>
<output>
<templates>
<directory>files</directory>
<includes>
<include>Dockerfile.mustache</include>
<include>.dockerignore</include>
</includes>
</templates>
<templates if="${native-image}">
<directory>files</directory>
<includes>
<include>Dockerfile.native.mustache</include>
</includes>
</templates>
<templates if="${jlink}">
<directory>files</directory>
<includes>
<include>Dockerfile.jlink.mustache</include>
</includes>
</templates>
<model>
<list key="readme-section">
<value order="50" template="mustache">
<![CDATA[
<inputs>
<boolean id="docker"
name="Docker support"
description="Add a Dockerfile to your project"
default="false"
optional="true">
<inputs>
<boolean id="native-image"
name="GraalVM Native Image Support"
description="Add a native-image capable Dockerfile to your project"
default="false"
optional="true"/>
<boolean id="jlink-image" name="JLink Support"
description="Add a JLink capable Dockerfile to your project"
default="false"
optional="true"/>
</inputs>
<output>
<files>
<directory>files</directory>
<includes>
<include>.dockerignore</include>
</includes>
</files>
<templates engine="mustache" transformations="mustache">
<directory>files</directory>
<includes>
<include>Dockerfile.mustache</include>
<include if="${native-image}">Dockerfile.native.mustache</include>
<include if="${jlink-image}">Dockerfile.jlink.mustache</include>
</includes>
</templates>
<model>
<list key="readme-section">
<value order="50" template="mustache">
<![CDATA[
## Build the Docker Image

```
docker build -t {{artifactId}} .
```
]]>
</value>
</list>
</model>
</output>
</boolean>
</inputs>
</step>
</value>
</list>
</model>
</output>
</boolean>
</inputs>
</archetype-script>
18 changes: 13 additions & 5 deletions archetypes/helidon/src/main/archetype/flavor.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,21 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://helidon.io/archetype/2.0 https://helidon.io/xsd/archetype-2.0.xsd">

<step label="Helidon Flavor">
<step name="Helidon Flavor" optional="true">
<inputs>
<enum name="flavor" label="Select a flavor" default="SE" global="true">
<option value="SE" label="Helidon SE">
<enum id="flavor"
name="Select a Flavor"
default="se"
global="true"
optional="true">
<option value="se"
name="Helidon SE"
description="Programmatic, reactive &amp; non blocking">
<exec src="se/se.xml"/>
</option>
<option value="MP" label="Helidon MP">
<option value="mp"
name="Helidon MP"
description="Declarative, MicroProfile compliant">
<exec src="mp/mp.xml"/>
</option>
</enum>
Expand All @@ -39,4 +47,4 @@
<value key="flavor">${flavor}</value>
</model>
</output>
</archetype-script>
</archetype-script>
18 changes: 12 additions & 6 deletions archetypes/helidon/src/main/archetype/mp/mp.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,30 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://helidon.io/archetype/2.0 https://helidon.io/xsd/archetype-2.0.xsd">

<step label="Application Type">
<step name="Application Type" optional="true">
<inputs>
<enum name="base" label="Select archetype" default="bare" global="true">
<option value="bare" label="Bare Helidon MP project suitable to start from scratch">
<enum id="app-type" name="Select archetype" default="bare" global="true" optional="true">
<option value="bare"
name="Bare"
description="Bare Helidon MP project suitable to start from scratch">
<exec src="bare/bare-mp.xml"/>
</option>
<option value="quickstart" label="Sample Helidon MP project that includes multiple REST operations">
<option value="quickstart"
name="Quickstart"
description="Sample Helidon MP project that includes multiple REST operations">
<exec src="quickstart/quickstart-mp.xml"/>
</option>
<option value="database" label="Helidon MP application that uses JPA with an in-memory H2 database">
<option value="database"
name="Database"
description="Helidon MP application that uses a database with JPA">
<exec src="database/database-mp.xml"/>
</option>
</enum>
</inputs>
</step>
<output>
<model>
<value key="base">${base}</value>
<value key="app-type">${app-type}</value>
</model>
</output>
</archetype-script>
17 changes: 10 additions & 7 deletions archetypes/helidon/src/main/archetype/se/se.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,28 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://helidon.io/archetype/2.0 https://helidon.io/xsd/archetype-2.0.xsd">

<step label="Application Type">
<step name="Application Type" optional="true">
<inputs>
<enum name="base" label="Select archetype" default="bare" global="true">
<option value="bare" label="Bare Helidon SE project suitable to start from scratch">
<enum id="app-type" name="Select archetype" default="bare" global="true" optional="true">
<option value="bare" name="Bare" description="Bare Helidon SE project suitable to start from scratch">
<exec src="bare/bare-se.xml"/>
</option>
<option value="quickstart" label="Sample Helidon SE project that includes multiple REST operations">
<option value="quickstart"
name="Quickstart"
description="Sample Helidon SE project that includes multiple REST operations">
<exec src="quickstart/quickstart-se.xml"/>
</option>
<option value="database"
label="Helidon SE application that uses the dbclient API with an in-memory H2 database">
name="Database"
description="Helidon SE application that uses a database with the DB Client API">
<exec src="database/database-se.xml"/>
</option>
</enum>
</inputs>
</step>
<output>
<model>
<value key="base">${base}</value>
<value key="app-type">${app-type}</value>
</model>
</output>
</archetype-script>
</archetype-script>
6 changes: 4 additions & 2 deletions docs/about/05_cli.adoc → docs/about/cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
= Helidon CLI
:description: Helidon CLI
:keywords: helidon cli
:rootdir: {docdir}/..

include::{rootdir}/includes/attributes.adoc[]

== Introduction

Expand Down Expand Up @@ -78,7 +81,7 @@ sudo mv ./helidon /usr/local/bin/
PowerShell -Command Invoke-WebRequest -Uri "https://helidon.io/cli/latest/windows/helidon.exe" -OutFile "C:\Windows\system32\helidon.exe"
----

For Windows you will also need the Visual C++ Redistributable Runtime. See <<about/04_windows.adoc,Helidon on Windows>>
For Windows you will also need the Visual C++ Redistributable Runtime. See xref:windows.adoc[Helidon on Windows]
for more information.

== Create a New Project
Expand All @@ -105,4 +108,3 @@ application.
== Demo

image::cli/Helidon_cli.gif[CLI Demo, align="center"]

Loading