Merge branch 'web-stuff' into 'master'

[web] Some restructuring of the developer guide

See merge request ogs/ogs!3709

web/config/_default/config.toml

@@ -37,24 +37,29 @@ identifier = "testing"
 weight = 3
 
 [[menu.devguide]]
-name = "Documentation"
-identifier = "documentation"
+name = "Third-party packages"
+identifier = "packages"
 weight = 4
 
+[[menu.devguide]]
+name = "Execution Environments"
+identifier = "environments"
+weight = 5
+
 [[menu.devguide]]
 name = "Advanced"
 identifier = "advanced"
-weight = 5
+weight = 6
 
 [[menu.devguide]]
 name = "Troubleshooting"
 identifier = "troubleshooting"
-weight = 6
+weight = 7
 
 [[menu.devguide]]
 name = "Procedures"
 identifier = "procedures"
-weight = 7
+weight = 8
 
 # Benchmarks sidebar top-level categories
 [[menu.benchmarks]]

web/content/docs/devguide/advanced/compiler-cache.md

@@ -2,7 +2,7 @@
 date = "2018-02-26T11:00:13+01:00"
 title = "Using a compiler cache"
 author = "Lars Bilke"
-weight = 1038
+weight = 1062
 
 aliases = ["/docs/devguide/advanced/using-ccache"]
 

web/content/docs/devguide/advanced/configuration-options.md

@@ -2,7 +2,7 @@
 date = "2018-02-26T11:00:13+01:00"
 title = "Configuration options"
 author = "Lars Bilke"
-weight = 1033
+weight = 1060
 
 [menu]
   [menu.devguide]

web/content/docs/devguide/advanced/gitlab-migration.md

@@ -2,7 +2,7 @@
 date = "2020-05-29T11:00:13+01:00"
 title = "Migrate to GitLab"
 author = "Lars Bilke"
-weight = 1043
+weight = 1069
 
 [menu]
   [menu.devguide]

web/content/docs/devguide/advanced/log-and-debug-output.md

@@ -2,7 +2,7 @@
 date = "2018-02-26T11:00:13+01:00"
 title = "Log and Debug Output"
 author = "Lars Bilke"
-weight = 1034
+weight = 1061
 
 [menu]
   [menu.devguide]

web/content/docs/devguide/advanced/wsl.md

@@ -2,7 +2,7 @@
 date = "2020-05-15T10:46"
 title = "Windows Subsystem for Linux"
 author = "Lars Bilke"
-weight = 1042
+weight = 1063
 
 [menu]
   [menu.devguide]

web/content/docs/devguide/development-workflows/code-reviews.md

@@ -30,3 +30,9 @@ If you do not want a reviewer to have a look, e.g. because you are currently wor
 
 - Set the merge request label to `workflow::please review`
 - Remove the [`Draft`-flag](https://docs.gitlab.com/ee/user/project/merge_requests/drafts.html#mark-merge-requests-as-ready) (if you have set it previously)
+
+### How to checkout a MR from another developer locally
+
+On the merge request page in the first box which contains information on the MR author and branch name there is button labelled `Check out branch` which will show you instructions on how to locally checkout this MR:
+
+![](../checkout-branch.png)

web/content/docs/devguide/documentation/introduction.md → web/content/docs/devguide/development-workflows/web-docs.md

 +++
 date = "2018-02-23T15:28:13+01:00"
-title = "Introduction"
+title = "Writing web documentation"
 author = "Lars Bilke"
 weight = 1024
 
 [menu.devguide]
-parent = "documentation"
+parent = "development-workflows"
+
+aliases = ["/docs/devguide/documentation/introduction/"]
+
 +++
 
 ## The big picture
@@ -21,7 +24,7 @@ parent = "documentation"
 ## Getting started
 
 - Inside the source-directory `ogs/web`:
-  - Run `yarn` once (this will install required css and js packages)
+  - Run `yarn` **and** `yarn build` once (this will install required css and js packages)
   - Run `hugo server`
   - Open [http://localhost:1313](http://localhost:1313)
 

web/content/docs/devguide/advanced/docker.md → web/content/docs/devguide/environments/docker.md

@@ -2,11 +2,13 @@
 date = "2018-02-26T11:00:13+01:00"
 title = "Docker"
 author = "Lars Bilke"
-weight = 1035
+weight = 1050
+
+aliases = ["/docs/devguide/advanced/docker"]
 
 [menu]
   [menu.devguide]
-    parent = "advanced"
+    parent = "environments"
 +++
 
 ## Introduction

web/content/docs/devguide/advanced/redistributable-builds.md → web/content/docs/devguide/environments/redistributable-builds.md

@@ -2,11 +2,13 @@
 date = "2018-02-26T11:00:13+01:00"
 title = "Redistributable builds"
 author = "Lars Bilke"
-weight = 1037
+weight = 1052
+
+aliases = ["/docs/devguide/advanced/redistributable-builds"]
 
 [menu]
   [menu.devguide]
-    parent = "advanced"
+    parent = "environments"
 +++
 
 ## Introduction

web/content/docs/devguide/advanced/singularity.md → web/content/docs/devguide/environments/singularity.md

@@ -2,11 +2,13 @@
 date = "2018-09-21T11:00:13+01:00"
 title = "Singularity"
 author = "Lars Bilke"
-weight = 1036
+weight = 1051
+
+aliases = ["/docs/devguide/advanced/singularity"]
 
 [menu]
   [menu.devguide]
-    parent = "advanced"
+    parent = "environments"
 +++
 
 <div class='note'>

web/content/docs/devguide/advanced/working-on-eve.md → web/content/docs/devguide/environments/working-on-eve.md

@@ -2,11 +2,13 @@
 date = "2018-02-26T11:00:13+01:00"
 title = "Working on Eve"
 author = "Lars Bilke"
-weight = 1040
+weight = 1053
+
+aliases = ["/docs/devguide/advanced/working-on-eve"]
 
 [menu]
   [menu.devguide]
-    parent = "advanced"
+    parent = "environments"
 +++
 
 ## Introduction

web/content/docs/devguide/advanced/conan-package-manager.md → web/content/docs/devguide/packages/conan-package-manager.md

@@ -2,11 +2,13 @@
 date = "2018-02-26T11:00:13+01:00"
 title = "Conan package manager"
 author = "Lars Bilke"
-weight = 1032
+weight = 1042
+
+aliases = ["/docs/devguide/advanced/conan-package-manager"]
 
 [menu]
   [menu.devguide]
-    parent = "advanced"
+    parent = "packages"
 +++
 
 <div class='note'>

web/content/docs/devguide/advanced/cpm.md → web/content/docs/devguide/packages/cpm.md

@@ -2,11 +2,13 @@
 date = "2021-02-11T10:46"
 title = "CMake dependency management"
 author = "Lars Bilke"
-weight = 1033
+weight = 1041
+
+aliases = ["/docs/devguide/advanced/cpm"]
 
 [menu]
   [menu.devguide]
-    parent = "advanced"
+    parent = "packages"
 +++
 
 We employ [CPM](https://github.com/cpm-cmake/CPM.cmake#options), a CMake dependency management solution, to integrate third-party dependencies.

web/content/docs/devguide/packages/mfront.md

++++
+date = "2021-07-19T11:34"
+title = "MFront"
+author = "Lars Bilke"
+weight = 1043
+
+[menu]
+  [menu.devguide]
+    parent = "packages"
++++
+
+MFront / TFEL support is enabled by the CMake-option `-DOGS_USE_MFRONT=ON` and can be installed
+
+- system-wide,
+- in the user directory or
+- automatically inside the ogs build-directory.
+
+## System-wide install
+
+If you install it system-wide it will get picked up by CMake (when the `mfront`-executable is in the `PATH`). Make sure to install a compatible version! Currently OGS requires the TFEL branch [rliv-{{< dataFile "versions.minimum_version.tfel-rliv" >}}](https://github.com/thelfer/tfel/tree/rliv-{{< dataFile "versions.minimum_version.tfel-rliv" >}}). Check the CMake output for version information of MFront / TFEL.
+
+## Installation in the user directory
+
+If you need another version of MFront / TFEL (e.g. for model development) as required for OGS one solution is to install MFront / TFEL in your user-directory with a version-suffix, see the [official documentation](http://tfel.sourceforge.net/install.html#sec:QuickUbuntu) for instructions! In this case you can use the mfront executable by using the binary name with the suffix, e.g. `mfront-4.0.0-dev` and OGS will automatically download and build a compatible MFront / TFEL version inside the build directory.
+
+## Automatic installation
+
+If you do not want to care about all this simply do **not** install MFront / TFEL and OGS will automatically download and build a compatible MFront / TFEL version inside the build directory.

web/content/docs/devguide/advanced/python-env.md → web/content/docs/devguide/packages/python-env.md

@@ -2,11 +2,13 @@
 date = "2020-10-05T15:16:13+01:00"
 title = "Python environment"
 author = "Lars Bilke"
-weight = 1030
+weight = 1040
+
+aliases = ["/docs/devguide/advanced/python-env"]
 
 [menu]
   [menu.devguide]
-    parent = "advanced"
+    parent = "packages"
 +++
 
 In OGS we make use of Python packages at different stages, e.g.:

web/content/docs/devguide/procedures/publish-a-release.md

@@ -2,7 +2,7 @@
 date = "2018-02-26T11:00:13+01:00"
 title = "Publish a release"
 author = "Lars Bilke"
-weight = 1051
+weight = 1080
 
 [menu]
   [menu.devguide]

web/content/docs/devguide/troubleshooting/build.md

@@ -2,7 +2,7 @@
 date = "2018-02-26T11:00:13+01:00"
 title = "Build"
 author = "Lars Bilke"
-weight = 1043
+weight = 1073
 
 [menu]
   [menu.devguide]

web/content/docs/devguide/troubleshooting/cmake.md

@@ -2,7 +2,7 @@
 date = "2018-02-26T11:00:13+01:00"
 title = "CMake"
 author = "Lars Bilke"
-weight = 1041
+weight = 1072
 
 [menu]
   [menu.devguide]