Skip to content

Commit ef75188

Browse files
stefanseifertstefanseifert
committed
prepare site generation
1 parent 0070a27 commit ef75188

File tree

8 files changed

+400
-5
lines changed

8 files changed

+400
-5
lines changed

‎parent_toplevel/pom.xml‎

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636

3737
<name>Toplevel Parent</name>
3838
<description>Toplevel POM for all wcm.io DevOps Maven projects.</description>
39+
<url>${site.url}/${site.url.module.prefix}/</url>
3940

4041
<scm>
4142
<connection>scm:git:https://github.com/wcm-io-devops/devops-tooling.git</connection>
@@ -44,11 +45,6 @@
4445
<tag>HEAD</tag>
4546
</scm>
4647

47-
<properties>
48-
<build.compiler.source>1.8</build.compiler.source>
49-
<build.compiler.target>1.8</build.compiler.target>
50-
</properties>
51-
5248
<inceptionYear>2015</inceptionYear>
5349

5450
<organization>
@@ -81,6 +77,20 @@
8177
</license>
8278
</licenses>
8379

80+
<properties>
81+
82+
<!-- compiler settings -->
83+
<build.compiler.source>1.8</build.compiler.source>
84+
<build.compiler.target>1.8</build.compiler.target>
85+
86+
<!-- site settings -->
87+
<site.url.module.prefix>tooling/parent_toplevel</site.url.module.prefix>
88+
<site.url>http://devops.wcm.io</site.url>
89+
<site.deploy.id>ssh-wcm.io</site.deploy.id>
90+
<site.deploy.url>scp://wcm.io:222/var/www/devops.wcm.io/www/</site.deploy.url>
91+
92+
</properties>
93+
8494
<dependencies>
8595

8696
<!-- Testing -->
@@ -168,6 +178,38 @@
168178
</configuration>
169179
</plugin>
170180

181+
<!-- site configuration -->
182+
<plugin>
183+
<groupId>org.apache.maven.plugins</groupId>
184+
<artifactId>maven-site-plugin</artifactId>
185+
<dependencies>
186+
<dependency>
187+
<groupId>lt.velykis.maven.skins</groupId>
188+
<artifactId>reflow-velocity-tools</artifactId>
189+
<version>1.1.1</version>
190+
</dependency>
191+
<!-- Reflow skin requires Velocity >= 1.7 -->
192+
<dependency>
193+
<groupId>org.apache.velocity</groupId>
194+
<artifactId>velocity</artifactId>
195+
<version>1.7</version>
196+
</dependency>
197+
</dependencies>
198+
<configuration>
199+
<generateReports>true</generateReports>
200+
<inputEncoding>UTF-8</inputEncoding>
201+
<outputEncoding>UTF-8</outputEncoding>
202+
</configuration>
203+
<executions>
204+
<execution>
205+
<id>attach-descriptor</id>
206+
<goals>
207+
<goal>attach-descriptor</goal>
208+
</goals>
209+
</execution>
210+
</executions>
211+
</plugin>
212+
171213
</plugins>
172214

173215
<pluginManagement>
@@ -268,4 +310,12 @@
268310
</profile>
269311
</profiles>
270312

313+
<distributionManagement>
314+
<site>
315+
<id>${site.deploy.id}</id>
316+
<name>Maven Site Deployment</name>
317+
<url>${site.deploy.url}${site.url.module.prefix}</url>
318+
</site>
319+
</distributionManagement>
320+
271321
</project>

‎parent_toplevel/src/site/site.xml‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
#%L
4+
wcm.io
5+
%%
6+
Copyright (C) 2015 wcm.io
7+
%%
8+
Licensed under the Apache License, Version 2.0 (the "License");
9+
you may not use this file except in compliance with the License.
10+
You may obtain a copy of the License at
11+
12+
http://www.apache.org/licenses/LICENSE-2.0
13+
14+
Unless required by applicable law or agreed to in writing, software
15+
distributed under the License is distributed on an "AS IS" BASIS,
16+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
See the License for the specific language governing permissions and
18+
limitations under the License.
19+
#L%
20+
-->
21+
22+
<project name="devops.wcm.io"
23+
xmlns="http://maven.apache.org/DECORATION/1.3.0"
24+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
25+
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 http://maven.apache.org/xsd/decoration-1.3.0.xsd">
26+
27+
<bannerLeft>
28+
<name><![CDATA[<img src="http://wcm.io/images/[email protected]"/> wcm.io DevOps]]></name>
29+
<href>http://devops.wcm.io</href>
30+
</bannerLeft>
31+
32+
<publishDate position="bottom" format="yyyy-MM-dd" />
33+
<version position="bottom" />
34+
35+
<skin>
36+
<groupId>io.wcm.maven.skins</groupId>
37+
<artifactId>reflow-maven-skin</artifactId>
38+
<version>1.0.0</version>
39+
</skin>
40+
<custom>
41+
<reflowSkin>
42+
<!-- Make this to 'false' for local development, i.e. file:// URLs -->
43+
<protocolRelativeURLs>false</protocolRelativeURLs>
44+
<smoothScroll>true</smoothScroll>
45+
<theme>default</theme>
46+
<highlightJs>true</highlightJs>
47+
<highlightJsTheme>github</highlightJsTheme>
48+
<absoluteResourceURL>http://wcm.io</absoluteResourceURL>
49+
<skinAttribution>false</skinAttribution>
50+
<brand>
51+
<!-- Brand text in top-left part of the site -->
52+
<name>wcm.io DevOps</name>
53+
<href>http://devops.wcm.io</href>
54+
</brand>
55+
<slogan>Tools for Configuration Management and Deployment</slogan>
56+
<titleTemplate>%2$s | %1$s</titleTemplate>
57+
<!-- Use Table of Contents as sidebar -->
58+
<toc>sidebar</toc>
59+
<!-- Include the documentation and tools in the top navigation (in addition to links) -->
60+
<topNav>Categories|Contribute</topNav>
61+
<!-- Split menus in the bottom navigation -->
62+
<bottomNav maxSpan="9" >
63+
<column>Main</column>
64+
<column>Categories</column>
65+
<column>Contribute</column>
66+
<column>reports</column>
67+
</bottomNav>
68+
<bottomDescription>
69+
<![CDATA[
70+
wcm.io DevOps is an Open Source project which provides tools for configuration management and deployment.
71+
]]>
72+
</bottomDescription>
73+
<pages>
74+
<index>
75+
<!-- no ToC on the main index page -->
76+
<toc>false</toc>
77+
<markPageHeader>false</markPageHeader>
78+
</index>
79+
<!-- Disable source highlighting for Maven reports -->
80+
<source-repository>
81+
<highlightJs>false</highlightJs>
82+
</source-repository>
83+
<issue-tracking>
84+
<highlightJs>false</highlightJs>
85+
<toc>false</toc>
86+
</issue-tracking>
87+
<license>
88+
<highlightJs>false</highlightJs>
89+
<toc>false</toc>
90+
</license>
91+
<!-- Disable ToC for some Maven reports -->
92+
<project-info>
93+
<toc>false</toc>
94+
</project-info>
95+
<github-report>
96+
<toc>false</toc>
97+
</github-report>
98+
<dependencies>
99+
<tocTopMax>4</tocTopMax>
100+
</dependencies>
101+
</pages>
102+
</reflowSkin>
103+
</custom>
104+
105+
<body>
106+
107+
<links>
108+
<item name="GitHub project" href="http://github.com/wcm-io-devops" />
109+
</links>
110+
111+
<breadcrumbs>
112+
<item name="wcm.io" href="http://wcm.io" />
113+
</breadcrumbs>
114+
115+
<menu name="Main" inherit="top">
116+
<item name="Home" href="http://devops.wcm.io" />
117+
<item name="Platforms" href="http://devops.wcm.io/platforms.html" />
118+
<item name="Maven Repositories" href="http://devops.wcm.io/maven.html" />
119+
<item name="GitHub project" href="http://github.com/wcm-io-devops" />
120+
<item name="Subprojects" href="http://wcm.io/subprojects.html" />
121+
<item name="License" href="http://devops.wcm.io/license.html" />
122+
<item name="Imprint" href="http://wcm.io/imprint.html" />
123+
</menu>
124+
<menu name="Categories" inherit="top">
125+
<item name="CONGA" href="http://wcm.io/conga/"/>
126+
</menu>
127+
<menu name="Contribute" inherit="top">
128+
<item name="Contribute" href="http://wcm.io/contribute.html" />
129+
<item name="Manifest" href="http://wcm.io/manifest.html" />
130+
<item name="Issues" href="https://wcm-io.atlassian.net" />
131+
<item name="Wiki" href="https://wcm-io.atlassian.net/wiki/" />
132+
<item name="Mailing Lists" href="http://wcm.io/mailing-lists.html" />
133+
<item name="Continuous Integration" href="https://travis-ci.org/wcm-io-devops" />
134+
<item name="Fork on GitHub" href="http://github.com/wcm-io-devops" />
135+
</menu>
136+
<menu name="Maven documentation" inherit="top" ref="reports"/>
137+
</body>
138+
139+
</project>

‎pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939

4040
<modules>
4141
<module>parent_toplevel</module>
42+
<module>public_site</module>
4243
</modules>
4344

4445
<build>

‎public_site/pom.xml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
#%L
4+
wcm.io
5+
%%
6+
Copyright (C) 2015 wcm.io
7+
%%
8+
Licensed under the Apache License, Version 2.0 (the "License");
9+
you may not use this file except in compliance with the License.
10+
You may obtain a copy of the License at
11+
12+
http://www.apache.org/licenses/LICENSE-2.0
13+
14+
Unless required by applicable law or agreed to in writing, software
15+
distributed under the License is distributed on an "AS IS" BASIS,
16+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
See the License for the specific language governing permissions and
18+
limitations under the License.
19+
#L%
20+
-->
21+
22+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
23+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
24+
<modelVersion>4.0.0</modelVersion>
25+
26+
<parent>
27+
<groupId>io.wcm.devops</groupId>
28+
<artifactId>io.wcm.devops.parent_toplevel</artifactId>
29+
<version>1.0.0-SNAPSHOT</version>
30+
<relativePath>../parent_toplevel/pom.xml</relativePath>
31+
</parent>
32+
33+
<groupId>io.wcm.devops</groupId>
34+
<artifactId>public_site</artifactId>
35+
<version>1</version>
36+
<packaging>pom</packaging>
37+
38+
<name>Public Site</name>
39+
<description>Project contains the public website content for the devops.wcm.io site root.</description>
40+
<url>${site.url}</url>
41+
42+
<scm>
43+
<connection>scm:git:https://github.com/wcm-io-devops/devops-tooling.git</connection>
44+
<developerConnection>scm:git:https://github.com/wcm-io-devops/devops-tooling.git</developerConnection>
45+
<url>https://github.com/wcm-io-devops/devops-tooling</url>
46+
<tag>HEAD</tag>
47+
</scm>
48+
49+
<build>
50+
<plugins>
51+
52+
<!-- do not deploy this project into maven repository -->
53+
<plugin>
54+
<groupId>org.apache.maven.plugins</groupId>
55+
<artifactId>maven-deploy-plugin</artifactId>
56+
<configuration>
57+
<skip>true</skip>
58+
</configuration>
59+
</plugin>
60+
61+
</plugins>
62+
</build>
63+
64+
<distributionManagement>
65+
<site>
66+
<id>${site.deploy.id}</id>
67+
<url>${site.deploy.url}</url>
68+
</site>
69+
</distributionManagement>
70+
71+
</project>

‎public_site/src/site/markdown/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
## About wcm.io DevOps
2+

‎public_site/src/site/markdown/maven.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
## Maven Repositories
2+
3+
### wcm.io Repository
4+
5+
The released wcm.io artifacts are available at Maven Central:
6+
7+
http://search.maven.org/#search|ga|1|io.wcm.devops
8+
9+
Snapshots releases are available on the Sonatype snapshot repository - use at your own risk!
10+
11+
https://oss.sonatype.org/content/repositories/snapshots/
12+
13+
The maven artifact coordinates are documented on the index page of each wcm.io module.
14+
15+
16+
### Apache Snapshot Repository
17+
18+
Sometimes snapshot are referenced from the Apache Snapshot repository:
19+
20+
```xml
21+
<repository>
22+
<id>apache-snapshots</id>
23+
<url>http://repository.apache.org/snapshots</url>
24+
<layout>default</layout>
25+
<releases>
26+
<enabled>false</enabled>
27+
</releases>
28+
<snapshots>
29+
<enabled>true</enabled>
30+
<updatePolicy>always</updatePolicy>
31+
</snapshots>
32+
</repository>
33+
```
34+
35+
36+
### wcm.io Intermediate Release Repository
37+
38+
This repository is hosted on wcm.io and provides intermediate releses with revision number from snapshots from the Apache SCM trunk which are not officially released currently. They are replaced with the official versions as soon as they are released by the Apache project.
39+
40+
```xml
41+
<repository>
42+
<id>wcm-io-apache-intermediate-release</id>
43+
<url>http://wcm.io/maven/repositories/apache-intermediate-release</url>
44+
<layout>default</layout>
45+
<releases>
46+
<enabled>true</enabled>
47+
<updatePolicy>never</updatePolicy>
48+
</releases>
49+
<snapshots>
50+
<enabled>false</enabled>
51+
</snapshots>
52+
</repository>
53+
54+
<pluginRepository>
55+
<id>wcm-io-apache-intermediate-release</id>
56+
<url>http://wcm.io/maven/repositories/apache-intermediate-release</url>
57+
<releases>
58+
<enabled>true</enabled>
59+
<updatePolicy>never</updatePolicy>
60+
</releases>
61+
<snapshots>
62+
<enabled>false</enabled>
63+
</snapshots>
64+
</pluginRepository>
65+
66+
```

‎public_site/src/site/markdown/platforms.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Supported Platforms
2+
3+
The wcm.io DevOps modules depend on the following system dependencies:
4+
5+
* Oracle Java 8

0 commit comments

Comments
 (0)