Skip to content

Commit e15dbd4

Browse files
committed
Some more cleanup for install guides
1 parent 3ee37ae commit e15dbd4

File tree

3 files changed

+57
-97
lines changed

3 files changed

+57
-97
lines changed

src/ozark/docs/install-javaee.adoc

Lines changed: 35 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -3,80 +3,63 @@ title: Install Guide for Java EE
33
template: page.html
44
---
55

6-
[[install-guide-for-java-ee]]
7-
Install Guide for Java EE
8-
~~~~~~~~~~~~~~~~~~~~~~~~~
6+
== Install Guide for Java EE
97

10-
MVC is built on top of JAX-RS. This means that Ozark can be run on most
11-
application servers without any additional configuration. You will just
12-
need to include the MVC API JAR as well as the Ozark module for the
13-
JAX-RS implementation shipped with your application server.
8+
MVC is built on top of JAX-RS. This means that Ozark can be run on most application servers without
9+
any additional configuration. You will just need to include the MVC API JAR as well as the Ozark module
10+
for the JAX-RS implementation shipped with your application server.
1411

15-
Ozark requires at least the Java EE 8 Web-Profile or the Eclipse
16-
MicroProfile.
12+
Ozark requires at least the Java EE 8 Web-Profile or the Eclipse MicroProfile.
1713

18-
Note: The MVC specification and Ozark are under active development.
19-
Therefore, you will have to add the Sonatype OSS snapshot repository to
20-
your POM to get the latest and greatest version. Please refer to
21-
link:install-snapshots.html[Setting up the snapshot repository] for
22-
details.
14+
NOTE: The MVC specification and Ozark are under active development. Therefore, we recommend to use the latest
15+
snapshots for your experiments. This will ensure, that you are using the latest version of both the API
16+
and the implementation. Please refer to link:install-snapshots.html[Using the latest snapshots] to learn more.
2317

24-
[[required-dependencies]]
25-
Required dependencies
26-
^^^^^^^^^^^^^^^^^^^^^
18+
=== Required dependencies
2719

28-
The dependencies you need to add to your `pom.xml` file depend on which
29-
application server your are using.
20+
The dependencies you need to add to your `pom.xml` file depend on which application server your are using.
3021

31-
[[glassfishpayara]]
32-
Glassfish/Payara
33-
++++++++++++++++
22+
==== Glassfish/Payara
3423

35-
Glassfish comes with Jersey as its JAX-RS implementation. Please add the
36-
following dependencies to your application:
24+
Glassfish comes with Jersey as its JAX-RS implementation. Please add the following dependencies to your
25+
application:
3726

3827
[source,xml]
3928
----
4029
<dependency>
4130
<groupId>javax.mvc</groupId>
4231
<artifactId>javax.mvc-api</artifactId>
43-
<version>{{versions.spec.develop}}</version>
32+
<version>{{versions.spec.latest}}</version>
4433
</dependency>
4534
<dependency>
4635
<groupId>org.mvc-spec.ozark</groupId>
4736
<artifactId>ozark-jersey</artifactId>
48-
<version>{{versions.ozark.develop}}</version>
37+
<version>{{versions.ozark.latest}}</version>
4938
</dependency>
5039
----
5140

52-
[[wildfly-and-jboss-eap]]
53-
Wildfly and JBoss EAP
54-
+++++++++++++++++++++
41+
==== Wildfly and JBoss EAP
5542

56-
Wildfly is using RESTEasy for JAX-RS. So you need to Ozark RESTEasy
57-
integration module:
43+
Wildfly is using RESTEasy for JAX-RS. So you need to Ozark RESTEasy integration module:
5844

5945
[source,xml]
6046
----
6147
<dependency>
6248
<groupId>javax.mvc</groupId>
6349
<artifactId>javax.mvc-api</artifactId>
64-
<version>{{versions.spec.develop}}</version>
50+
<version>{{versions.spec.latest}}</version>
6551
</dependency>
6652
<dependency>
6753
<groupId>org.mvc-spec.ozark</groupId>
6854
<artifactId>ozark-resteasy</artifactId>
69-
<version>{{versions.ozark.develop}}</version>
55+
<version>{{versions.ozark.latest}}</version>
7056
</dependency>
7157
----
7258

73-
[[wildfly-swarm]]
74-
Wildfly Swarm
75-
+++++++++++++
59+
==== Wildfly Swarm
7660

77-
We currently don't have a dedicated fraction for wildfly Swarm, but you
78-
can use the JAX-RS fraction and add the same dependencies as required
79-
for Wildfly:
61+
We currently don't have a dedicated fraction for wildfly Swarm, but you can use the JAX-RS fraction and add
62+
the same dependencies as required for Wildfly:
8063

8164
[source,xml]
8265
----
@@ -87,56 +70,51 @@ for Wildfly:
8770
<dependency>
8871
<groupId>javax.mvc</groupId>
8972
<artifactId>javax.mvc-api</artifactId>
90-
<version>{{versions.spec.develop}}</version>
73+
<version>{{versions.spec.latest}}</version>
9174
</dependency>
9275
<dependency>
9376
<groupId>org.mvc-spec.ozark</groupId>
9477
<artifactId>ozark-resteasy</artifactId>
95-
<version>{{versions.ozark.develop}}</version>
78+
<version>{{versions.ozark.latest}}</version>
9679
</dependency>
9780
----
9881

99-
[[apache-tomee]]
100-
Apache TomEE
101-
++++++++++++
82+
==== Apache TomEE
10283

103-
Apache TomEE uses CXF as the JAX-RS implementation. Unfortunately there
104-
are some known bugs in CXF which are causing trouble for Ozark. The
105-
latest CXF release should fix these issues, but Apache TomEE currently
106-
ships with an older CXF release.
84+
Apache TomEE uses CXF as the JAX-RS implementation. Unfortunately there are some known bugs in CXF
85+
which are causing trouble for Ozark. The latest CXF release should fix these issues, but
86+
Apache TomEE currently ships with an older CXF release.
10787

108-
If you want to give Ozark on Apache TomEE a try, add the following
109-
dependencies to your `pom.xml`:
88+
If you want to give Ozark on Apache TomEE a try, add the following dependencies to your `pom.xml`:
11089

11190
[source,xml]
11291
----
11392
<dependency>
11493
<groupId>javax.mvc</groupId>
11594
<artifactId>javax.mvc-api</artifactId>
116-
<version>{{versions.spec.develop}}</version>
95+
<version>{{versions.spec.latest}}</version>
11796
</dependency>
11897
<dependency>
11998
<groupId>org.mvc-spec.ozark</groupId>
12099
<artifactId>ozark-core</artifactId>
121-
<version>{{versions.ozark.develop}}</version>
100+
<version>{{versions.ozark.latest}}</version>
122101
</dependency>
123102
----
124103

125-
If using CXF with Ozark is causing trouble, you can also manually add
126-
RESTEasy to your application and use this instead of CXF. To do so, use
127-
the following depndencies instead.
104+
If using CXF with Ozark is causing trouble, you can also manually add RESTEasy to your application and
105+
use this instead of CXF. To do so, use the following depndencies instead.
128106

129107
[source,xml]
130108
----
131109
<dependency>
132110
<groupId>javax.mvc</groupId>
133111
<artifactId>javax.mvc-api</artifactId>
134-
<version>{{versions.spec.develop}}</version>
112+
<version>{{versions.spec.latest}}</version>
135113
</dependency>
136114
<dependency>
137115
<groupId>org.mvc-spec.ozark</groupId>
138116
<artifactId>ozark-resteasy</artifactId>
139-
<version>{{versions.ozark.develop}}</version>
117+
<version>{{versions.ozark.latest}}</version>
140118
</dependency>
141119
<dependency>
142120
<groupId>org.jboss.resteasy</groupId>

src/ozark/docs/install-servlet.adoc

Lines changed: 21 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,26 @@ title: Install Guide for Servlet Containers
33
template: page.html
44
---
55

6-
[[install-guide-for-servlet-containers]]
7-
Install Guide for Servlet Containers
8-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9-
10-
The simplest way to get started with MVC is to deploy your app to a
11-
JavaEE 7 application server. In this setup the application server will
12-
provider JAX-RS, CDI and Beań Validation implemnetations for you. Please
13-
refer to link:install-javaee.html[Install Guide for Java EE] for details
6+
== Install Guide for Servlet Containers
7+
8+
The simplest way to get started with MVC is to deploy your app to a JavaEE 7 application server.
9+
In this setup the application server will provider JAX-RS, CDI and Beań Validation implemnetations
10+
for you. Please refer to link:install-javaee.html[Install Guide for Java EE] for details
1411
about this setup.
1512

16-
However, there is a large number of users who prefer to run their
17-
applications on plain Servlet containers like Apache Tomcat and Jetty.
18-
In this setup you will have to provider JAX-RS, CDI and Bean Validations
13+
However, there is a large number of users who prefer to run their applications on plain Servlet containers
14+
like Apache Tomcat and Jetty. In this setup you will have to provider JAX-RS, CDI and Bean Validations
1915
yourself.
2016

21-
In this guide we will show you how to run Ozark on Apache Tomcat using
22-
Weld, RESTEasy and Hibernate Validator.
17+
In this guide we will show you how to run Ozark on Apache Tomcat using Weld, RESTEasy and Hibernate Validator.
2318

24-
Note: The MVC specification and Ozark are under active development.
25-
Therefore, you will have to add the Sonatype OSS snapshot repository to
26-
your POM to get the latest and greatest version. Please refer to
27-
link:install-snapshots.html[Setting up the snapshot repository] for
28-
details.
19+
NOTE: The MVC specification and Ozark are under active development. Therefore, we recommend to use the latest
20+
snapshots for your experiments. This will ensure, that you are using the latest version of both the API
21+
and the implementation. Please refer to link:install-snapshots.html[Using the latest snapshots] to learn more.
2922

30-
[[required-dependencies]]
31-
Required dependencies
32-
^^^^^^^^^^^^^^^^^^^^^
23+
=== Required dependencies
3324

34-
The following `pom.xml` example shows the dependency configuration for
35-
your application:
25+
The following `pom.xml` example shows the dependency configuration for your application:
3626

3727
[source,xml]
3828
----
@@ -73,21 +63,18 @@ your application:
7363
<dependency>
7464
<groupId>javax.mvc</groupId>
7565
<artifactId>javax.mvc-api</artifactId>
76-
<version>{{versions.spec.develop}}</version>
66+
<version>{{versions.spec.latest}}</version>
7767
</dependency>
7868
<dependency>
7969
<groupId>org.mvc-spec.ozark</groupId>
8070
<artifactId>ozark-resteasy</artifactId>
81-
<version>{{versions.ozark.develop}}</version>
71+
<version>{{versions.ozark.latest}}</version>
8272
</dependency>
8373
----
8474

85-
[[configuration-files]]
86-
Configuration files
87-
^^^^^^^^^^^^^^^^^^^
75+
=== Configuration files
8876

89-
Make sure to add an empty `beans.xml` file in your
90-
`/src/main/webapp/WEB-INF` folder:
77+
Make sure to add an empty `beans.xml` file in your `/src/main/webapp/WEB-INF` folder:
9178

9279
[source,xml]
9380
----
@@ -100,8 +87,7 @@ Make sure to add an empty `beans.xml` file in your
10087
</beans>
10188
----
10289

103-
Please also add a file called `context.xml` to
104-
`src/main/resources/META-INF`:
90+
Please also add a file called `context.xml` to `src/main/resources/META-INF`:
10591

10692
[source,xml]
10793
----
@@ -115,13 +101,10 @@ Please also add a file called `context.xml` to
115101
</Context>
116102
----
117103

118-
This file `context.xml` is essential for the operation of the CDI in
119-
Tomcat as described in the
120-
http://docs.jboss.org/weld/reference/latest/en-US/html_single/#tomcat[Weld
121-
documentation].
104+
This file `context.xml` is essential for the operation of the CDI in Tomcat as described in the
105+
link:http://docs.jboss.org/weld/reference/latest/en-US/html_single/#tomcat[Weld documentation].
122106

123-
The file to create is called `web.xml` and should be placed in the
124-
`src/main/webapp/WEB-INF` directory:
107+
The file to create is called `web.xml` and should be placed in the `src/main/webapp/WEB-INF` directory:
125108

126109
[source,xml]
127110
----

src/ozark/docs/install-snapshots.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ title: Install Guide for Java EE
33
template: page.html
44
---
55

6-
[[setting-up-the-snapshot-repository]]
7-
== Setting up the snapshot repository
6+
== Using the latest snapshots
87

98
The MVC specification and Ozark are under active development. Therefore, we recommend to use the latest
109
snapshots for your experiments. This will ensure, that you are using the latest version of both the API

0 commit comments

Comments
 (0)