Work on reducing download size of manual

GeoCat · Sep 15, 2023 · fe6e5f4 · fe6e5f4
1 parent 291a344
commit fe6e5f4
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 2 deletions.
diff --git a/docs/manual/README.md b/docs/manual/README.md
@@ -12,6 +12,31 @@ Reference:
 
 The [project issue tracker](https://github.com/geonetwork/core-geonetwork/issues) is used for communication, with ongoing topics tagged [documentation](https://github.com/geonetwork/core-geonetwork/issues?q=is%3Aissue+label%3Adocumenation).
 
+
+## Maven Integration
+
+1. Build documentation with ``compile`` phase:
+   ```
+   mvn compile
+   ```
+
+2. Assemble ``zip`` with ``package`` phase:
+   ```bash
+   mvn compile
+   ```
+
+3. Both ``install`` and ``deploy`` are skipped (so ``mvn clean install`` is fine).
+
+4. Use profile to include specific language:
+   ```
+   mvn install -Pfrench
+   ```
+
+   Or flag for all of them:
+   ```
+   mvn install -Dall
+   ```
+
 ## Material for MkDocs
 
 Documentation is [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) which is a Markdown documentation framework written on top of [MkDocs](https://www.mkdocs.org/).

diff --git a/docs/manual/mkdocs.yml b/docs/manual/mkdocs.yml
@@ -40,7 +40,6 @@ theme:
 
 plugins:
   - search
-  - offline
   - i18n:
       docs_structure: suffix
       languages:
@@ -51,7 +50,7 @@ plugins:
           site_name: 'GeoNetwork (en)'
         - locale: fr
           name: Français
-          build: true
+          build: !ENV [FRENCH,false]
           site_name: 'GeoNetwork (fr)'
           nav_translations:
             Home: Home

diff --git a/docs/manual/overrides/main.html b/docs/manual/overrides/main.html
@@ -0,0 +1,5 @@
+{% extends "base.html" %}
+
+{% block announce %}
+  Preview GeoNetwork documentation in mkdocs, feedback welcome on <a href="https://github.com/geonetwork/core-geonetwork/issues/7286">core-geonetwork#7286</a>
+{% endblock %}
diff --git a/docs/manual/pom.xml b/docs/manual/pom.xml
@@ -33,6 +33,9 @@
   <artifactId>gn-guide</artifactId>
   <name>GeoNetwork Guide</name>
   <packaging>pom</packaging>
+  <properties>
+     <french>false</french>
+  </properties>
   <licenses>
     <license>
       <name>Creative Commons Attribution 3.0 License</name>
@@ -55,7 +58,9 @@
             <configuration>
               <target>
                 <exec executable="mkdocs" failonerror="true" dir="${basedir}">
+                  <env key="FRENCH" value="${french}"/>
                   <arg line="build"/>
+                  <arg line="--no-directory-urls"/>
                 </exec>
               </target>
             </configuration>
@@ -98,4 +103,18 @@
     </plugins>
   </build>
 
+<profiles>
+  <profile>
+    <id>french</id>
+    <activation>
+      <property>
+        <name>all</name>
+      </property>
+    </activation>
+    <properties>
+       <french>true</french>
+    </properties>
+  </profile>
+</profiles>
+
 </project>
diff --git a/docs/manual/src/assembly/guide.xml b/docs/manual/src/assembly/guide.xml
@@ -6,6 +6,13 @@
   <fileSets>
     <fileSet>
       <directory>target/html</directory>
+      <outputDirectory></outputDirectory>
+      <excludes>
+        <exclude>**/*.rst</exclude>
+        <exclude>confy.py</exclude>
+        <exclude>anchors.txt</exclude>
+        <exclude>404.html</exclude>
+      </excludes>
     </fileSet>
   </fileSets>
 </assembly>