Skip to content

Commit 3ee37ae

Browse files
chkalchkal
committed
Converted some files to AsciiDoc
1 parent 3cab807 commit 3ee37ae

File tree

2 files changed

+120
-74
lines changed

2 files changed

+120
-74
lines changed

‎src/ozark/docs/install-javaee.md renamed to ‎src/ozark/docs/install-javaee.adoc

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

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

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.
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.
1114

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

14-
Note: The MVC specification and Ozark are under active development. Therefore, you will have to add
15-
the Sonatype OSS snapshot repository to your POM to get the latest and greatest version.
16-
Please refer to [Setting up the snapshot repository](install-snapshots.html) for details.
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.
1723

18-
### Required dependencies
24+
[[required-dependencies]]
25+
Required dependencies
26+
^^^^^^^^^^^^^^^^^^^^^
1927

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

23-
#### Glassfish/Payara
31+
[[glassfishpayara]]
32+
Glassfish/Payara
33+
++++++++++++++++
2434
25-
Glassfish comes with Jersey as its JAX-RS implementation. Please add the following dependencies
26-
to your application:
35+
Glassfish comes with Jersey as its JAX-RS implementation. Please add the
36+
following dependencies to your application:
2737
28-
```xml
38+
[source,xml]
39+
----
2940
<dependency>
3041
<groupId>javax.mvc</groupId>
3142
<artifactId>javax.mvc-api</artifactId>
@@ -36,13 +47,17 @@ to your application:
3647
<artifactId>ozark-jersey</artifactId>
3748
<version>{{versions.ozark.develop}}</version>
3849
</dependency>
39-
```
50+
----
4051
41-
#### Wildfly and JBoss EAP
52+
[[wildfly-and-jboss-eap]]
53+
Wildfly and JBoss EAP
54+
+++++++++++++++++++++
4255

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

45-
```xml
59+
[source,xml]
60+
----
4661
<dependency>
4762
<groupId>javax.mvc</groupId>
4863
<artifactId>javax.mvc-api</artifactId>
@@ -53,14 +68,18 @@ Wildfly is using RESTEasy for JAX-RS. So you need to Ozark RESTEasy integration
5368
<artifactId>ozark-resteasy</artifactId>
5469
<version>{{versions.ozark.develop}}</version>
5570
</dependency>
56-
```
71+
----
5772

58-
#### Wildfly Swarm
73+
[[wildfly-swarm]]
74+
Wildfly Swarm
75+
+++++++++++++
5976
60-
We currently don't have a dedicated fraction for wildfly Swarm, but you can use the
61-
JAX-RS fraction and add the same dependencies as required for Wildfly:
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:
6280
63-
```xml
81+
[source,xml]
82+
----
6483
<dependency>
6584
<groupId>org.wildfly.swarm</groupId>
6685
<artifactId>jaxrs</artifactId>
@@ -75,17 +94,22 @@ JAX-RS fraction and add the same dependencies as required for Wildfly:
7594
<artifactId>ozark-resteasy</artifactId>
7695
<version>{{versions.ozark.develop}}</version>
7796
</dependency>
78-
```
97+
----
7998
80-
#### Apache TomEE
99+
[[apache-tomee]]
100+
Apache TomEE
101+
++++++++++++
81102

82-
Apache TomEE uses CXF as the JAX-RS implementation. Unfortunately there are some known bugs in CXF
83-
which are causing trouble for Ozark. The latest CXF release should fix these issues, but Apache TomEE
84-
currently ships with an older CXF release.
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.
85107

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

88-
```xml
111+
[source,xml]
112+
----
89113
<dependency>
90114
<groupId>javax.mvc</groupId>
91115
<artifactId>javax.mvc-api</artifactId>
@@ -96,12 +120,14 @@ If you want to give Ozark on Apache TomEE a try, add the following dependencies
96120
<artifactId>ozark-core</artifactId>
97121
<version>{{versions.ozark.develop}}</version>
98122
</dependency>
99-
```
123+
----
100124

101-
If using CXF with Ozark is causing trouble, you can also manually add RESTEasy to your application
102-
and use this instead of CXF. To do so, use the following depndencies instead.
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.
103128

104-
```xml
129+
[source,xml]
130+
----
105131
<dependency>
106132
<groupId>javax.mvc</groupId>
107133
<artifactId>javax.mvc-api</artifactId>
@@ -122,6 +148,6 @@ and use this instead of CXF. To do so, use the following depndencies instead.
122148
<artifactId>resteasy-servlet-initializer</artifactId>
123149
<version>3.1.4.Final</version>
124150
</dependency>
125-
```
151+
----
126152

127-
That's all. Now you can start developing your first MVC 1.0 application.
153+
That's all. Now you can start developing your first MVC 1.0 application.

‎src/ozark/docs/install-servlet.md renamed to ‎src/ozark/docs/install-servlet.adoc

Lines changed: 57 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,39 @@ title: Install Guide for Servlet Containers
33
template: page.html
44
---
55

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 [Install Guide for Java EE](install-javaee.html) for details about this setup.
11-
12-
However, there is a large number of users who prefer to run their applications on plain Servlet
13-
containers like Apache Tomcat and Jetty. In this setup you will have to provider JAX-RS,
14-
CDI and Bean Validations yourself.
15-
16-
In this guide we will show you how to run Ozark on Apache Tomcat using Weld, RESTEasy and
17-
Hibernate Validator.
18-
19-
Note: The MVC specification and Ozark are under active development. Therefore, you will have to add
20-
the Sonatype OSS snapshot repository to your POM to get the latest and greatest version.
21-
Please refer to [Setting up the snapshot repository](install-snapshots.html) for details.
22-
23-
### Required dependencies
24-
25-
The following `pom.xml` example shows the dependency configuration for your application:
26-
27-
```xml
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
14+
about this setup.
15+
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
19+
yourself.
20+
21+
In this guide we will show you how to run Ozark on Apache Tomcat using
22+
Weld, RESTEasy and Hibernate Validator.
23+
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.
29+
30+
[[required-dependencies]]
31+
Required dependencies
32+
^^^^^^^^^^^^^^^^^^^^^
33+
34+
The following `pom.xml` example shows the dependency configuration for
35+
your application:
36+
37+
[source,xml]
38+
----
2839
<!-- Get the API JARs for Java EE 7 -->
2940
<dependency>
3041
<groupId>javax</groupId>
@@ -69,25 +80,31 @@ The following `pom.xml` example shows the dependency configuration for your appl
6980
<artifactId>ozark-resteasy</artifactId>
7081
<version>{{versions.ozark.develop}}</version>
7182
</dependency>
72-
```
83+
----
7384

74-
### Configuration files
85+
[[configuration-files]]
86+
Configuration files
87+
^^^^^^^^^^^^^^^^^^^
7588

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

78-
```xml
92+
[source,xml]
93+
----
7994
<?xml version="1.0"?>
8095
<beans xmlns="http://xmlns.jcp.org/xml/ns/javaee"
8196
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
8297
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd"
8398
version="1.1" bean-discovery-mode="all">
8499
85100
</beans>
86-
```
101+
----
87102

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

90-
```xml
106+
[source,xml]
107+
----
91108
<?xml version="1.0" encoding="UTF-8"?>
92109
<Context>
93110
@@ -96,15 +113,18 @@ Please also add a file called `context.xml` to `src/main/resources/META-INF`:
96113
factory="org.jboss.weld.resources.ManagerObjectFactory"/>
97114
98115
</Context>
99-
```
116+
----
100117

101-
This file `context.xml` is essential for the operation of the CDI in Tomcat as described in
102-
the [Weld documentation](http://docs.jboss.org/weld/reference/latest/en-US/html_single/#tomcat).
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].
103122

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

107-
```xml
126+
[source,xml]
127+
----
108128
<?xml version="1.0" encoding="UTF-8"?>
109129
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
110130
xmlns="http://java.sun.com/xml/ns/javaee"
@@ -127,6 +147,6 @@ directory:
127147
</context-param>
128148
129149
</web-app>
130-
```
150+
----
131151

132-
That's all. Now you can start developing your first MVC 1.0 application.
152+
That's all. Now you can start developing your first MVC 1.0 application.

0 commit comments

Comments
 (0)