Merge pull request #2572 from bilke/web-checker

Web link checker

Jenkinsfile

 #!/usr/bin/env groovy
 @Library('jenkins-pipeline@1.0.22') _
 
-def stage_required = [build: false, data: false, full: false, docker: false]
+def stage_required = [build: false, full: false]
 def build_shared = 'ON'
 
 pipeline {
@@ -69,14 +69,6 @@ pipeline {
                   stage_required.build = true
                   echo "Doing regular build."
                 }
-                if (path.startsWith("Tests/Data") && !stage_required.data) {
-                  stage_required.data = true
-                  echo "Updating Tests/Data."
-                }
-                if (path.startsWith("scripts/docker") && !stage_required.docker) {
-                  stage_required.docker = true
-                  echo "Doing Docker images build."
-                }
               }
             }
           }
@@ -646,7 +638,7 @@ pipeline {
           when {
             beforeAgent true
             allOf {
-              expression { return params.master_jobs && stage_required.data }
+              expression { return params.master_jobs }
               environment name: 'JOB_NAME', value: 'ufz/ogs/master'
             }
           }
@@ -698,6 +690,26 @@ pipeline {
             }
           }
         }
+        // *************************** Web *************************************
+        stage('Web') {
+          agent {
+            dockerfile {
+              filename 'Dockerfile.web'
+              dir 'scripts/docker'
+              label 'docker'
+            }
+          }
+          when {
+            beforeAgent true
+            environment name: 'JOB_NAME', value: 'ufz/ogs/master'
+          }
+          steps {
+            dir('web') {
+              sh 'hugo'
+              sh 'broken-links-checker --path ./public --baseUrl https://www.opengeosys.org'
+            }
+          }
+        }
         // *************************** Post ************************************
         stage('Post') {
           agent { label "master"}

scripts/docker/Dockerfile.web

+FROM node
+RUN npm install -g @hashicorp/broken-links-checker
+RUN wget https://github.com/gohugoio/hugo/releases/download/v0.55.6/hugo_0.55.6_Linux-64bit.deb \
+    && dpkg -i hugo_0.55.6_Linux-64bit.deb && rm hugo_0.55.6_Linux-64bit.deb
+RUN apt-get update -y && apt-get install -y --no-install-recommends pandoc \
+    && rm -rf /var/lib/apt/lists/*
+ENTRYPOINT /bin/bash

web/.linksrc.json

+{
+  "excludePatterns": [
+    "^https?://.*localhost",
+    "^https?://github.com/ufz/ogs/releases/.*",
+    "https://jenkins.opengeosys.org/job/ufz/job/ogs-container-maker/job/master/build",
+    "https://dev.azure.com/ogsci/ogs/_build",
+    "https://ogs.jfrog.io/ogs"
+  ]
+}

web/README.md

@@ -2,7 +2,7 @@
 
 - Development related content such as developer guide, benchmark documentation, tools description, ... will be simple Markdown files in e.g. [/web/content/docs](https://github.com/bilke/ogs/blob/web-hugo/web/content/docs/benchmarks/elliptic/groundwater-flow-neumann.md)
 - You can preview documentation locally with [Hugo](https://gohugo.io) – a static site generator
-- You can [mark](https://github.com/bilke/ogs/blob/web-hugo/ProcessLib/GroundwaterFlow/CMakeLists.txt#L80) benchmarks to be automatically and interactively visualized [in the documentation](https://github.com/bilke/ogs/commit/d4fc7d94a3821a6b4483a1d7aeaabd6ee391c449#diff-2f5b1ac2a759aa09b2d3f5cc1ece45ceR108) inside your [browser](https://dev.opengeosys.org/docs/benchmarks/elliptic/groundwater-flow-neumann/#results-and-evaluation) via [vtk.js](https://kitware.github.io/vtk-js/)! 🍻 CURRENTLY DISABLED!
+- You can [mark](https://github.com/bilke/ogs/blob/web-hugo/ProcessLib/GroundwaterFlow/CMakeLists.txt#L80) benchmarks to be automatically and interactively visualized [in the documentation](https://github.com/bilke/ogs/commit/d4fc7d94a3821a6b4483a1d7aeaabd6ee391c449#diff-2f5b1ac2a759aa09b2d3f5cc1ece45ceR108) inside your [browser](https://opengeosys.org/docs/benchmarks/elliptic/groundwater-flow-neumann/#results-and-evaluation) via [vtk.js](https://kitware.github.io/vtk-js/)! 🍻 CURRENTLY DISABLED!
 
 ## Requirements
 
@@ -153,3 +153,11 @@ ALGOLIA_WRITE_KEY=XXX node_modules/.bin/hugo-algolia --toml -s
 - [FontAwesome](https://fontawesome.com) - Icons, see [icon search](https://fontawesome.com/icons?d=gallery)
 - [Slick Carousel](http://kenwheeler.github.io/slick/) & [FancyBox](https://fancyapps.com/fancybox/3/) for image galleries
 - [Algolia](https://github.com/algolia/algoliasearch-client-javascript) for site search
+
+### Link checker
+
+```
+npm install -g @hashicorp/broken-links-checker
+hugo
+broken-links-checker --path ./public --baseUrl https://www.opengeosys.org
+```

web/content/docs/benchmarks/bgr_verification_examples/hydromechanics.pandoc

@@ -2,7 +2,7 @@
 date = "2019-04-24T15:15:45+01:00"
 title = "Hydromechanics: Verification examples by Vogel, Maßmann"
 weight = 40
-project = "Hydromechanics/Verification"
+project = "HydroMechanics/Verification"
 author = "Johannes Herfurth, Jan Thiedau"
 
 [menu]

web/content/docs/benchmarks/hydro-component/theis/HC_Theis.pandoc

 +++
 author = "Marc Walther"
 weight = 142
-project = "Parabolic/ComponentTransport/Theis/HC_theis.prj"
+project = "Parabolic/ComponentTransport/Theis/theis.prj"
 date = "2019-05-02T14:41:09+01:00"
 title = "Theis solution for well pumping"
 
@@ -44,8 +44,6 @@ Mass transport properties are irrelevant as no transport processes are calculate
 
 Initial conditions are $c = 0$ and hydrostatic pressure conditions.
 
-{{< data-link "Link to the HC_theis project file" "Parabolic/ComponentTransport/HC_Theis/HC_theis.prj" >}}
-
 
 ### Results
 

web/content/docs/benchmarks/reactive-transport/kineticreactant_allascomponents/KineticReactant2.pandoc

 +++
 author = "Johannes Boog"
 weight = 143
-project = "Parabolic/ReactiveTransport/KineticReactant_AllAsComponents/"
+project = "Parabolic/ComponentTransport/ReactiveTransport/KineticReactant_AllAsComponents/KineticReactant2.prj"
 date = "2010-06-25T14:41:09+01:00"
 title = "Solute transport including kinetic reaction"
 

web/content/docs/devguide/advanced/docker.pandoc

@@ -76,4 +76,3 @@ The following images are used by Jenkins:
 - `ogs6/gcc`, defined in [scripts/docker/Dockerfile.gcc.full](https://github.com/ufz/ogs/blob/master/scripts/docker/Dockerfile.gcc.full)
 - `ogs6/gcc:gui`, defined in [scripts/docker/Dockerfile.gcc.gui](https://github.com/ufz/ogs/blob/master/scripts/docker/Dockerfile.gcc.gui)
 - `ogs6/clang`, defined in [scripts/docker/Dockerfile.clang.full](https://github.com/ufz/ogs/blob/master/scripts/docker/Dockerfile.clang.full)
-- `ogs6/clang:gui`, defined in [scripts/docker/Dockerfile.clang.gui](https://github.com/ufz/ogs/blob/master/scripts/docker/Dockerfile.clang.gui)

web/content/docs/devguide/advanced/redistributable-builds.pandoc

@@ -40,7 +40,7 @@ If a binary runs on a different machine depends on a lot of factors. The followi
 
 #### For optimization
 
-- `OGS_CPU_ARCHITECTURE`: tot to `native` for best optimization for your current cpu, possible values are [listed here](http:/bilityoverflow.com/a/25095818/80480), more info on [gcc docs](https://gcc.gnu.org/onlinedocs/gcc/x86-Options.html#index-mtune-15)
+- `OGS_CPU_ARCHITECTURE`: tot to `native` for best optimization for your current cpu, possible values are [listed here](https://stackoverflow.com/a/25095818/80480), more info on [gcc docs](https://gcc.gnu.org/onlinedocs/gcc/x86-Options.html#index-mtune-15)
 - `OGS_ENABLE_AVX2`: boolean (sets `-march=core-avx2` when set to true), requires at least Haswell processors
 :::
 

web/content/internal/vis.html

-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <title>Title</title>
-</head>
-<body>
-<div class=content></div>
-
-<script type="text/javascript" src="/js/bundle.js"></script>
-</body>
-</html>

web/content/releases/6.1.0.md

@@ -26,8 +26,8 @@ The following notable changes and new features were implemented between OpenGeoS
   now handle both of the monolithic and staggered schemes.  So far,  HT classes
   get the staggered scheme based on this new framework of  assembly.
   https://github.com/ufz/ogs/pull/1970
-- Heterogeneous liquid flow properties  (https://github.com/ufz/ogs/pull/1979,
-  https://github.com/ufz/ogs/pull/2017)
+- Heterogeneous liquid flow properties  [#1979](https://github.com/ufz/ogs/pull/1979),
+  [#2017](https://github.com/ufz/ogs/pull/2017)
 - New boundary conditions added: Nonuniform Dirichlet
   (https://github.com/ufz/ogs/pull/1952) and Neumann
   (https://github.com/ufz/ogs/pull/1891), and normal traction
@@ -51,12 +51,11 @@ The following notable changes and new features were implemented between OpenGeoS
   https://github.com/ufz/ogs/pull/1936
 
 #### Testing and documentation:
-- Insitu visualization with ParaView Catalyst. See
-  [presentation](https://github.com/ufz/ogs/files/867280/Insitu-Department.pdf).
+- Insitu visualization with ParaView Catalyst.
   [#1744](https://github.com/ufz/ogs/pull/1744), [#1732](https://github.com/ufz/ogs/pull/1732). As a consequence VTK 7.1 is now required.
 - Benchmark docs are now part of the code (in `web/content`) and can contain
   [interactive 3D
-  visualizations](https://dev.opengeosys.org/docs/benchmarks/elliptic/groundwater-flow-neumann/#results-and-evaluation)
+  visualizations](https://opengeosys.org/docs/benchmarks/elliptic/groundwater-flow-neumann/#results-and-evaluation)
   via [vtk.js](https://kitware.github.io/vtk-js/). [#1706](https://github.com/ufz/ogs/pull/1706), [#1714](https://github.com/ufz/ogs/pull/1714), [#1723](https://github.com/ufz/ogs/pull/1723), [#1729](https://github.com/ufz/ogs/pull/1729).
 - Migrated handling of test data files from *git-submodule* to *git-lfs*, see
   [docs](https://docs.opengeosys.org/docs/devguide/testing/test-data). [#1964](https://github.com/ufz/ogs/pull/1964),

web/content/releases/6.2.0.md

@@ -141,9 +141,9 @@ The following notable changes and new features were implemented between OpenGeoS
   TecPlot files. [#2114](https://github.com/ufz/ogs/pull/2114)
 - `TecPlot-Reader`: converting TecPlot rasters into OGS meshes (one file per
   zone, containing all variables as scalar arrays). [#2114](https://github.com/ufz/ogs/pull/2114)
-- [`constructMeshesFromGeometry`](https://www.opengeosys.org/docs/tools/model-preparation/constructmeshesfromgeometry/):
+- [`constructMeshesFromGeometry`](https://www.opengeosys.org/docs/tools/meshing-submeshes/constructmeshesfromgeometry/):
   Construction of boundary meshes from bulk mesh and gml files. [#2144](https://github.com/ufz/ogs/pull/2144)
-- [`identifySubdomains`](https://www.opengeosys.org/docs/tools/model-preparation/identifysubdomains/):
+- [`identifySubdomains`](https://www.opengeosys.org/docs/tools/meshing-submeshes/identifysubdomains/):
   Identification of boundary meshes (or any subdomains in general) in the bulk
   mesh. Performs geometrical tests and creates and verifies necessary
   `bulk_node_ids` and `bulk_element_ids` maps. [#2227](https://github.com/ufz/ogs/pull/2227), [#2252](https://github.com/ufz/ogs/pull/2252)