Skip to content
Permalink
Browse files
Switched from Ant to Maven for site generation. This depends on the n…
…ew freemarker-docgen-maven artifact.
  • Loading branch information
ddekany committed Jul 12, 2020
1 parent ef8db46 commit 6db138cef851de63785a7d64b30490e25ea5b908
Showing 5 changed files with 109 additions and 237 deletions.
22 README
@@ -20,13 +20,19 @@
Apache FreeMarker Site
----------------------

This is the project with which we generate the freemarker.apache.org home page.
Note that most of the work is done by Apache FreeMarker Docgen, which is
a dependency of this project.
This is the project that generates the freemarker.apache.org home page,
except the documentation of FreeMarker, or of other released products.
Note that most of the work is done by the freemarker-docgen depedency. (If
Maven can't get the proper version of that depedency, try the Apache Maven
repository, or you have to check out freemarker-docgen "mvn install" it
locally.)

To publish the built site, commit the output into the "asf-site" branch.
To build the site, issue:

Note that as of this writing, the "docgen" dependency is get from the Ivy
repo on the published homepage (https://freemarker.apache.org/repos/ivy/). Those
modifying docgen should upload the fresh docgen jar there. Then you need to
run `ant update-deps` here to grab the latest version.
mvn package

This will output the site into target/site. To publish the built site, commit the
output into the "asf-site" branch of the freemarker-site Git repo.

This project shouldn't be deployed or installed, as it produces no
meaningful artifact.
144 build.xml

This file was deleted.

32 ivy.xml

This file was deleted.

This file was deleted.

95 pom.xml
@@ -0,0 +1,95 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.apache</groupId>
<artifactId>apache</artifactId>
<version>23</version>
</parent>

<groupId>org.apache.freemarker.site</groupId>
<artifactId>freemarker-site</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>Apache FreeMarker Site</name>
<description>Internally used tool to generate FreeMarker web site</description>

<properties>
<siteOutputDirectory>${project.build.directory}/site</siteOutputDirectory>
</properties>

<build>
<plugins>
<plugin>
<groupId>org.apache.freemarker.docgen</groupId>
<artifactId>freemarker-docgen-maven</artifactId>
<version>0.0.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>transform</goal>
</goals>
</execution>
</executions>
<configuration>
<sourceDirectory>src/main/docgen</sourceDirectory>
<outputDirectory>${siteOutputDirectory}</outputDirectory>
<offline>true</offline>
</configuration>
</plugin>
<plugin>
<artifactId>maven-antrun-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<configuration>
<target>
<!-- Copy project meta-data file: -->
<copy file="doap.rdf" todir="${siteOutputDirectory}" />
</target>
</configuration>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
</plugin>

<plugin>
<groupId>org.apache.rat</groupId>
<artifactId>apache-rat-plugin</artifactId>
<version>0.13</version>
<executions>
<execution>
<phase>verify</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
<configuration>
<excludesFile>rat-excludes</excludesFile>
</configuration>
</plugin>
</plugins>
</build>
</project>

0 comments on commit 6db138c

Please sign in to comment.