Skip to content

Commit

Permalink
integrate into maven build
Browse files Browse the repository at this point in the history
  • Loading branch information
jodygarnett committed Sep 15, 2023
1 parent 8ab4e19 commit a669858
Show file tree
Hide file tree
Showing 7 changed files with 228 additions and 3 deletions.
2 changes: 0 additions & 2 deletions docs/help/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,6 @@ theme:

plugins:
- search
- tags:
tags_file: tags.md
- i18n:
default_language: en
docs_structure: suffix
Expand Down
101 changes: 101 additions & 0 deletions docs/help/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright (C) 2001-2016 Food and Agriculture Organization of the
~ United Nations (FAO-UN), United Nations World Food Programme (WFP)
~ and United Nations Environment Programme (UNEP)
~
~ This program is free software; you can redistribute it and/or modify
~ it under the terms of the GNU General Public License as published by
~ the Free Software Foundation; either version 2 of the License, or (at
~ your option) any later version.
~
~ This program is distributed in the hope that it will be useful, but
~ WITHOUT ANY WARRANTY; without even the implied warranty of
~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
~ General Public License for more details.
~
~ You should have received a copy of the GNU General Public License
~ along with this program; if not, write to the Free Software
~ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
~
~ Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2,
~ Rome - Italy. email: [email protected]
-->
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<parent>
<artifactId>gn-docs</artifactId>
<groupId>org.geonetwork-opensource</groupId>
<version>4.4.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>gn-help</artifactId>
<name>Online Help</name>
<packaging>pom</packaging>
<licenses>
<license>
<name>Creative Commons Attribution 3.0 License</name>
<url>http://creativecommons.org/licenses/by/3.0/</url>
<distribution>repo</distribution>
</license>
</licenses>

<build>
<plugins>
<plugin>
<artifactId>maven-antrun-plugin</artifactId>
<executions>
<execution>
<id>mkdocs</id>
<phase>compile</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<target>
<exec executable="mkdocs" failonerror="true" dir="${basedir}">
<arg line="build"/>
</exec>
</target>
</configuration>
</execution>
</executions>
</plugin>
<!-- package distribution -->
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
<execution>
<id>make-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
<configuration>
<finalName>geonetwork-help-${project.version}</finalName>
<descriptors>
<descriptor>src/assembly/help.xml</descriptor>
</descriptors>
</configuration>
</plugin>
<!-- no need to install this to local repo -->
<plugin>
<artifactId>maven-install-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
<!-- no need to deploy to nexus repo -->
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
</plugins>
</build>

</project>
11 changes: 11 additions & 0 deletions docs/help/src/assembly/help.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<assembly>
<id>help</id>
<formats>
<format>zip</format>
</formats>
<fileSets>
<fileSet>
<directory>target/html</directory>
</fileSet>
</fileSets>
</assembly>
1 change: 1 addition & 0 deletions docs/manual/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ theme:

plugins:
- search
- offline
- i18n:
docs_structure: suffix
languages:
Expand Down
101 changes: 101 additions & 0 deletions docs/manual/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright (C) 2001-2016 Food and Agriculture Organization of the
~ United Nations (FAO-UN), United Nations World Food Programme (WFP)
~ and United Nations Environment Programme (UNEP)
~
~ This program is free software; you can redistribute it and/or modify
~ it under the terms of the GNU General Public License as published by
~ the Free Software Foundation; either version 2 of the License, or (at
~ your option) any later version.
~
~ This program is distributed in the hope that it will be useful, but
~ WITHOUT ANY WARRANTY; without even the implied warranty of
~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
~ General Public License for more details.
~
~ You should have received a copy of the GNU General Public License
~ along with this program; if not, write to the Free Software
~ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
~
~ Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2,
~ Rome - Italy. email: [email protected]
-->
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<parent>
<artifactId>gn-docs</artifactId>
<groupId>org.geonetwork-opensource</groupId>
<version>4.4.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>gn-guide</artifactId>
<name>GeoNetwork Guide</name>
<packaging>pom</packaging>
<licenses>
<license>
<name>Creative Commons Attribution 3.0 License</name>
<url>http://creativecommons.org/licenses/by/3.0/</url>
<distribution>repo</distribution>
</license>
</licenses>

<build>
<plugins>
<plugin>
<artifactId>maven-antrun-plugin</artifactId>
<executions>
<execution>
<id>mkdocs</id>
<phase>compile</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<target>
<exec executable="mkdocs" failonerror="true" dir="${basedir}">
<arg line="build"/>
</exec>
</target>
</configuration>
</execution>
</executions>
</plugin>
<!-- package distribution -->
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
<execution>
<id>make-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
<configuration>
<finalName>geonetwork-help-${project.version}</finalName>
<descriptors>
<descriptor>src/assembly/guide.xml</descriptor>
</descriptors>
</configuration>
</plugin>
<!-- no need to install this to local repo -->
<plugin>
<artifactId>maven-install-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
<!-- no need to deploy to nexus repo -->
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
</plugins>
</build>

</project>
11 changes: 11 additions & 0 deletions docs/manual/src/assembly/guide.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<assembly>
<id>guide</id>
<formats>
<format>zip</format>
</formats>
<fileSets>
<fileSet>
<directory>target/html</directory>
</fileSet>
</fileSets>
</assembly>
4 changes: 3 additions & 1 deletion docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@
</license>
</licenses>
<modules>
<module>help</module>
<module>manual</module>
<!--<module>schema-doc</module>-->
<module>manuals</module>
<!--module>manuals</module>-->
</modules>
</project>

0 comments on commit a669858

Please sign in to comment.