diff --git a/web/config/_default/config.toml b/web/config/_default/config.toml index 148ebfaffc4e7fb478e2b2a6fde4348a59a4df5f..e8bd84048a695787717ef22dd1cd31296d5fedcf 100644 --- a/web/config/_default/config.toml +++ b/web/config/_default/config.toml @@ -9,23 +9,6 @@ staticDir = ["dist", "static"] [params] alert = "" -# Main menu -[[menu.main]] - name = "Releases" - url = "/releases/" - identifier = "releases" - weight = 3 -[[menu.main]] - name = "Docs" - url = "/docs/" - identifier = "docs" - weight = 4 -[[menu.main]] - name = "Publications" - url = "/publications/" - identifier = "publications" - weight = 5 - # Devguide sidebar menu top-level categories [[menu.devguide]] name = "Getting Started" @@ -155,3 +138,19 @@ staticDir = ["dist", "static"] name = "Workflows" identifier = "workflows" weight = 5 + +# docs +[[menu.docs]] +name = "Data Explorer Manual" +url = "https://gitlab.opengeosys.org/ogs/data_explorer_manual/-/jobs/artifacts/master/raw/ogsde-man.pdf?job=build" +post = "Manual for the graphical user interface for OpenGeoSys, the Data Explorer." + +[[menu.docs]] +name = "Source code documentation" +url = "https://doxygen.opengeosys.org/" +post = "The OGS source code documentation is automatically generated right from the code itself via Doxygen and is nice reference while coding." + +[[menu.docs]] +name = "Styleguide" +url = "https://ufz.github.io/styleguide/cppguide.xml" +post = "OpenGeoSys C++ Style Guide" diff --git a/web/content/books/bmb-2.pandoc b/web/content/books/bmb-2.pandoc index ab38907173def5dbed1998c74da8777e163ae9ed..7d63e4d5ddbe0b9ad0ddad93f0ce89f72aeab65f 100644 --- a/web/content/books/bmb-2.pandoc +++ b/web/content/books/bmb-2.pandoc @@ -5,7 +5,7 @@ date = 2018-03-02T12:49:25+01:00 author = "Lars Bilke" categories = ["Books"] -image = "BMB-2-Cover.png" +image = "/books/BMB-2-Cover.png" +++ diff --git a/web/content/books/bmb-3.pandoc b/web/content/books/bmb-3.pandoc index ca844889ac39091e736a1fc9338b7d719606764b..c5c725d84e010a806f2e52b5c3693cc97bf68509 100644 --- a/web/content/books/bmb-3.pandoc +++ b/web/content/books/bmb-3.pandoc @@ -5,7 +5,7 @@ date = 2018-03-05T16:27:48+01:00 author = "Lars Bilke" categories = ["Books"] -image = "BMB-3-Cover.png" +image = "/books/BMB-3-Cover.png" +++ diff --git a/web/content/books/bmb-4.pandoc b/web/content/books/bmb-4.pandoc index 73ea17bd1d0425a7a4871b60a8394aa4d522e3a7..bfb30dffa70dec6f7b6e6565b5f4358d35583a8d 100644 --- a/web/content/books/bmb-4.pandoc +++ b/web/content/books/bmb-4.pandoc @@ -5,7 +5,7 @@ date = 2018-03-07T15:35:30+01:00 author = "Lars Bilke" categories = ["Books"] -image = "bmb-4.png" +image = "/books/bmb-4.png" +++ diff --git a/web/content/books/computational-geotechnics-i.pandoc b/web/content/books/computational-geotechnics-i.pandoc index d75057198d116cbff37b79071de0126660ad591b..ff3db4c8591224895f58df8e086cac93ac8a91e4 100644 --- a/web/content/books/computational-geotechnics-i.pandoc +++ b/web/content/books/computational-geotechnics-i.pandoc @@ -5,7 +5,7 @@ date = 2018-03-07T15:27:05+01:00 author = "Lars Bilke" categories = ["Tutorials"] -image = "computational-geotechnics-i.png" +image = "/books/computational-geotechnics-i.png" +++ [<i class="far fa-file-pdf"></i> Download this book as PDF](https://ogsstorage.blob.core.windows.net/web/Books/Comp-Geotechnics-I/Computational_Geotechnics_I.pdf) diff --git a/web/content/books/computational-hydrology-i-groundwater-flow-modeling.pandoc b/web/content/books/computational-hydrology-i-groundwater-flow-modeling.pandoc index dc69871034ee3f4933d11094c1e7030f72ec72e8..cc368e6239436a6c8505aa469df58bf2170accb7 100644 --- a/web/content/books/computational-hydrology-i-groundwater-flow-modeling.pandoc +++ b/web/content/books/computational-hydrology-i-groundwater-flow-modeling.pandoc @@ -4,7 +4,7 @@ date = 2018-03-01T15:51:37+01:00 author = "Lars Bilke" categories = ["Tutorials"] -image = "Computation-Hydrology-I-Cover.png" +image = "/books/Computation-Hydrology-I-Cover.png" +++ diff --git a/web/content/books/computational-hydrology-ii.pandoc b/web/content/books/computational-hydrology-ii.pandoc index c85ba12b4eaeea58dd17e856b4dc486df6e0252a..164fa422a321ac61190c87f7cc3fcb0079caea60 100644 --- a/web/content/books/computational-hydrology-ii.pandoc +++ b/web/content/books/computational-hydrology-ii.pandoc @@ -5,7 +5,7 @@ date = 2018-03-07T15:20:04+01:00 author = "[TODO]" categories = ["Tutorials"] -image = "computational-hydrology-ii.png" +image = "/books/computational-hydrology-ii.png" +++ diff --git a/web/content/books/computational-hydrology-iii.pandoc b/web/content/books/computational-hydrology-iii.pandoc index e31e3c7d575b497a8a22aba8b2031c33e8fe901f..06916f6b4f20acb923b61d60d626a5ec2a71d66f 100644 --- a/web/content/books/computational-hydrology-iii.pandoc +++ b/web/content/books/computational-hydrology-iii.pandoc @@ -5,7 +5,7 @@ date = 2018-06-18T08:20:04+01:00 author = "Eunseon Jang" categories = ["Tutorials"] -image = "Computational-Hydrology-III-Cover.jpg" +image = "/books/Computational-Hydrology-III-Cover.jpg" +++ [<i class="far fa-file-pdf"></i> Download this book as PDF](https://ogsstorage.blob.core.windows.net/web/Books/Computational-Hydrology-III/Computational-Hydrology-III.pdf) diff --git a/web/content/books/geoenergy-modeling-i.pandoc b/web/content/books/geoenergy-modeling-i.pandoc index 39d5654ea9063790b4eca03d3799599f446da910..b0275390ca2c750421e13713b9617cd6ca6e3410 100644 --- a/web/content/books/geoenergy-modeling-i.pandoc +++ b/web/content/books/geoenergy-modeling-i.pandoc @@ -5,7 +5,7 @@ date = 2018-03-07T14:58:32+01:00 author = "Lars Bilke" categories = ["Tutorials"] -image = "geoenergy-modeling-i.png" +image = "/books/geoenergy-modeling-i.png" aliases = [ "/tutorials/ces-i/e07", "/tutorials/ces-i/e08", "/tutorials/ces-i/e09", "/tutorials/ces-i/e10" ] diff --git a/web/content/books/geoenergy-modeling-ii.pandoc b/web/content/books/geoenergy-modeling-ii.pandoc index ef078d690994876c7652bddab061a68fdbf13c79..655e0f48fb77fffeafd3f063c29a75745e85f73a 100644 --- a/web/content/books/geoenergy-modeling-ii.pandoc +++ b/web/content/books/geoenergy-modeling-ii.pandoc @@ -5,7 +5,7 @@ date = 2018-03-07T14:59:32+01:00 author = "Lars Bilke" categories = ["Tutorials"] -image = "geoenergy-modeling-ii.png" +image = "/books/geoenergy-modeling-ii.png" aliases = [ "/books/shallow-geothermal-systems" ] diff --git a/web/content/books/geoenergy-modeling-iii.pandoc b/web/content/books/geoenergy-modeling-iii.pandoc index a5f77a4ccc1de1a0701a75b8dab98d199a798b77..ed1192e0ba23df46840eef906be51786c997ef34 100644 --- a/web/content/books/geoenergy-modeling-iii.pandoc +++ b/web/content/books/geoenergy-modeling-iii.pandoc @@ -5,7 +5,7 @@ date = 2018-03-07T15:13:52+01:00 author = "Lars Bilke" categories = ["Tutorials"] -image = "geoenergy-modeling-iii.png" +image = "/books/geoenergy-modeling-iii.png" +++ diff --git a/web/content/books/models-of-thermochemical-heat-storage.pandoc b/web/content/books/models-of-thermochemical-heat-storage.pandoc index 224891e79c6f1d2a29e33e6b9c31967b1754deef..d27a40cda82bbe28aeab76b009cc4b53cfdaf015 100644 --- a/web/content/books/models-of-thermochemical-heat-storage.pandoc +++ b/web/content/books/models-of-thermochemical-heat-storage.pandoc @@ -4,7 +4,7 @@ date = 2018-03-07T15:31:45+01:00 author = "Lars Bilke" categories = ["Tutorials"] -image = "models-of-thermochemical-heat-storage.png" +image = "/books/models-of-thermochemical-heat-storage.png" +++ diff --git a/web/content/categories/books/_index.md b/web/content/categories/books/_index.md index 07e9a638b13d2cbd4a15e24444a37eac02d80f7c..ff6a3787f753613fa21daa27261c76d532cd3068 100644 --- a/web/content/categories/books/_index.md +++ b/web/content/categories/books/_index.md @@ -1,6 +1,9 @@ ---- -title: "Books" -aliases: [/books/] ---- ++++ +title = "Books" + +[menu.publications] +post = "Comprehensive benchmark descriptions and theory." +weight = 2 ++++ We publish a series of books on OpenGeoSys. They contain comprehensive benchmark descriptions and can be seen as a reference to what is possible with OGS. diff --git a/web/content/categories/tutorials/_index.md b/web/content/categories/tutorials/_index.md index 27237c7e105f2d7ad624485b02a9a7360f335b85..a3f1553a4806ebd660c22719cf33397f6972d5f8 100644 --- a/web/content/categories/tutorials/_index.md +++ b/web/content/categories/tutorials/_index.md @@ -1,5 +1,10 @@ ---- -title: "Tutorials" ---- ++++ +title = "Tutorials" + +[menu.publications] +post = "Step-by-step instructions on specific topics." +weight = 3 + ++++ We publish a series of tutorials on OpenGeoSys. They focus on specific topics with step-by-step instructions giving the user a good introduction into modeling and simulation with OGS. Most of the tutorials can be downloaded as PDF! See the detail page on each tutorial. diff --git a/web/content/docs/_index.pandoc b/web/content/docs/_index.pandoc index c265e7278d17f34d6b45c03f99d740b8e5ad74c7..982eed8b921ace18f495a8a4362b61ddfe504f01 100644 --- a/web/content/docs/_index.pandoc +++ b/web/content/docs/_index.pandoc @@ -1,48 +1,11 @@ +++ title = "Documentation" +layout = "section/docs.html" -[[sections]] -name = "User Guide" -url = "/docs/userguide/basics/introduction/" -text = "Download, install and run an OGS benchmark in 5 minutes! No development setup required." -icon = "far fa-users" - -[[sections]] -name = "Developer Guide" -url = "/docs/devguide/getting-started/introduction/" -text = "You want to contribute to the OpenGeoSys project or implement a custom feature? In the Developer Guide you will find everything to get you started into OpenGeoSys development. Experienced developers will find a comprehensive list of advanced development topics." -icon = "far fa-laptop-code" - -[[sections]] -name = "Benchmarks" -url = "/docs/benchmarks/elliptic/elliptic-dirichlet/" -text = "Basic benchmarks are explained and input files are provided to get you started in using OGS." -icon = "far fa-rabbit-fast" - -[[sections]] -name = "Tools & Workflows" -url = "/docs/tools/getting-started/overview/" -text = "Helpful tools for pre- and postprocessing as well as complete model setup workflows." -icon = "far fa-tools" - -[[sections]] -name = "Data Explorer Manual" -url = "https://gitlab.opengeosys.org/ogs/data_explorer_manual/-/jobs/artifacts/master/raw/ogsde-man.pdf?job=build" -text = "Manual for the graphical user interface for OpenGeoSys, the Data Explorer." -icon = "far fa-file-image" - -[[sections]] -name = "Source code documentation" -url = "https://doxygen.opengeosys.org/" -text = "The OGS source code documentation is automatically generated right from the code itself via Doxygen and is nice reference while coding." -icon = "far fa-file-code" - -[[sections]] -name = "Styleguide" -url = "https://ufz.github.io/styleguide/cppguide.xml" -text = "OpenGeoSys C++ Style Guide" -icon = "far fa-file-check" - +[menu.main] +name = "Docs" +identifier = "docs" +weight = 2 +++ <h1 class="sm:text-3xl text-2xl font-medium title-font mb-2 text-gray-900">OpenGeoSys documentation overview</h1> diff --git a/web/content/docs/benchmarks/elliptic/elliptic-dirichlet.pandoc b/web/content/docs/benchmarks/elliptic/elliptic-dirichlet.pandoc index 740b8ab16325efb4124d39cc2ed03fa706097bb0..6f749ac875a3344efed0307f76affdab9a6d28d4 100644 --- a/web/content/docs/benchmarks/elliptic/elliptic-dirichlet.pandoc +++ b/web/content/docs/benchmarks/elliptic/elliptic-dirichlet.pandoc @@ -5,9 +5,15 @@ project = "Elliptic/square_1x1_SteadyStateDiffusion/square_1e2.prj" author = "Dmitri Naumov" weight = 102 -[menu] - [menu.benchmarks] - parent = "elliptic" + +[menu.docs] +name = "Benchmarks" +identifier = "benchmarks" +weight = 3 +post = "Basic benchmarks are explained and input files are provided to get you started in using OGS." + +[menu.benchmarks] +parent = "elliptic" +++ diff --git a/web/content/docs/devguide/getting-started/introduction.pandoc b/web/content/docs/devguide/getting-started/introduction.pandoc index d3e4a9b542d9b434acd00de6f64d8cd8c70bcc01..3c2d0e8c9ea2233e6dd8b42ae189ffe62b955b47 100644 --- a/web/content/docs/devguide/getting-started/introduction.pandoc +++ b/web/content/docs/devguide/getting-started/introduction.pandoc @@ -4,9 +4,15 @@ title = "Welcome!" author = "Lars Bilke" weight = 1001 -[menu] - [menu.devguide] - parent = "getting-started" +[menu.docs] +name = "Developer Guide" +identifier = "devguide" +weight = 2 +post = "You want to contribute to the OpenGeoSys project or implement a custom feature? In the Developer Guide you will find everything to get you started into OpenGeoSys development. Experienced developers will find a comprehensive list of advanced development topics." + +[menu.devguide] +parent = "getting-started" + +++ In this help section you will find everything related to development. Please walk through the Getting Started-section **step by step**. At the end you will have the latest OGS source code, the OGS finite element simulator compiled and everything you need to start developing for OGS! This first section of the developer guide will give you just a brief introduction, make sure to read the more advanced topics after you have familiarized yourself with the basics. diff --git a/web/content/docs/tools/getting-started/overview.pandoc b/web/content/docs/tools/getting-started/overview.pandoc index efdb7d883173292b737e132efbabc4aae6c92ccb..d97ac3332975e197cd1dda75d28de8d48e2b3316 100644 --- a/web/content/docs/tools/getting-started/overview.pandoc +++ b/web/content/docs/tools/getting-started/overview.pandoc @@ -4,9 +4,15 @@ title = "Introduction" author = "Lars Bilke" weight = 100 -[menu] - [menu.tools] - parent = "getting-started" + +[menu.docs] +name = "Tools & Workflows" +identifier = "tools" +weight = 4 +post = "Helpful tools for pre- and postprocessing as well as complete model setup workflows." + +[menu.tools] +parent = "getting-started" +++ Here is an overview of the currently available command line tools, that might help you to construct your OpenGeoSys model. GUI-based tools are available too: diff --git a/web/content/docs/userguide/basics/introduction.pandoc b/web/content/docs/userguide/basics/introduction.pandoc index 60daa3f3d92a6e7ba4e63b6fe8d31f02371dfeee..ed6bbe3835b9ff35409a09eace40e40b5c30340d 100644 --- a/web/content/docs/userguide/basics/introduction.pandoc +++ b/web/content/docs/userguide/basics/introduction.pandoc @@ -4,6 +4,12 @@ title = "Introduction" author = "Lars Bilke" weight = 1 +[menu.docs] +name = "User Guide" +identifier = "userguide" +weight = 1 +post = "Download, install and run an OGS benchmark in 5 minutes! No development setup required." + aliases = [ "/docs/userguide/", "/docs/quickstart/", "/docs/quickstart/basics/quickstart" ] # Redirect for Hydrology III tutorial @@ -33,7 +39,7 @@ You can download the latest benchmark files from GitLab: See [the Benchmarks section](/docs/benchmarks/) for more information on the benchmarks. - + ## Running diff --git a/web/content/publications/_index.pandoc b/web/content/publications/_index.pandoc index 97099b66ec78daed03ead7fd333c47abdfe6a9cf..ab5d6371f51be5cd75198156d77ce762b1928aed 100644 --- a/web/content/publications/_index.pandoc +++ b/web/content/publications/_index.pandoc @@ -1,23 +1,8 @@ +++ title = "Publications" -[[sections]] -name = "Paper" -url = "/publications/paper" -text = "Peer-reviewed scientific paper about OpenGeoSys and its applications." -icon = "far fa-users" - -[[sections]] -name = "Books" -url = "/categories/books" -text = "Comprehensive benchmark descriptions and theory." -icon = "far fa-laptop-code" - -[[sections]] -name = "Tutorials" -url = "/categories/tutorials" -text = "Step-by-step instructions on specific topics." -icon = "far fa-rabbit-fast" +[menu.main] +weight = 3 +++ diff --git a/web/content/publications/paper.pandoc b/web/content/publications/paper.pandoc index edb1b7fcbe76392bfc78b7498fc400a0798d2968..539d0933f85b91737dc49aa75d71c1d7060df683 100644 --- a/web/content/publications/paper.pandoc +++ b/web/content/publications/paper.pandoc @@ -1,3 +1,7 @@ ---- -Title: "Paper" ---- ++++ +Title = "Paper" + +[menu.publications] +post = "Peer-reviewed scientific paper about OpenGeoSys and its applications." +weight = 1 ++++ diff --git a/web/content/releases/_index.pandoc b/web/content/releases/_index.pandoc index 7b0bc9e9ee430c92731c2fcdbe4347daa7be49de..aceaae92e6dacadaaa404eda069b491402a0aea0 100644 --- a/web/content/releases/_index.pandoc +++ b/web/content/releases/_index.pandoc @@ -1,6 +1,10 @@ +++ Title = "Releases" +[menu.main] +name = "Releases" +weight = 1 + aliases = ["/downloads", "/download"] # Redirect for Hydrology II tutorial [[head_downloads]] @@ -30,7 +34,7 @@ icon = "fab fa-windows" [[head_downloads]] name = "Latest Singularity container CLI with Utilities" url = "https://gitlab.opengeosys.org/ogs/ogs/-/jobs/artifacts/master/browse/_out/images?job=container" -note = "Download and run .sif-file with [Singularity](/docs/devguide/advanced/singularity/)" +note = "Download and run .sif-file with [Singularity](/docs/userguide/basics/container/)" icon = "far fa-container-storage" [[head_downloads]] diff --git a/web/layouts/_default/summary.html b/web/layouts/_default/summary.html index 2d1f6fb7059907d3921fa97151d7ebc8fc910b7a..3145dfd27bfb98d599eb7c5482aad51ce978d6af 100644 --- a/web/layouts/_default/summary.html +++ b/web/layouts/_default/summary.html @@ -1,7 +1,7 @@ <article class="mb-8 border-b"> {{ if .Params.image }} <div class="w-1/6 float-left mr-4 mb-2"> - <img class="shadow-md" src="{{ .Permalink }}../{{ .Params.image }}" alt=""> + <img class="shadow-md" src="{{ .Params.image }}" alt=""> </div> {{ end }} diff --git a/web/layouts/books/single.html b/web/layouts/books/single.html index 37b414e6f4563d03f7593ff35aeb3985530dafe0..410daa048615548063639327f1e2df7f3d3b69db 100644 --- a/web/layouts/books/single.html +++ b/web/layouts/books/single.html @@ -2,7 +2,7 @@ <div class="container"> <h1>{{ .Title }} {{ if .Params.subtitle }}<span class="text-regular text-gray-600">– {{ .Params.subtitle }}</span>{{ end }}</h1> - <img class="w-1/6 float-left mr-4 mb-2 shadow-md" src="../{{ .Params.image }}" alt=""> + <img class="w-1/6 float-left mr-4 mb-2 shadow-md" src="{{ .Params.image }}" alt=""> {{ .Content }} </div> {{ end }} diff --git a/web/layouts/partials/header.html b/web/layouts/partials/header.html index 69ce115af887e139ddc620ec07136a30ef169c5f..315cc8d8c8e986c2321d9877b6cf53c1eed016bb 100644 --- a/web/layouts/partials/header.html +++ b/web/layouts/partials/header.html @@ -46,8 +46,8 @@ {{ range .Site.Menus.main }} {{ $url_trimmed := trim .URL "/" }} <a href="{{ .URL }}" class="nav-item{{if (eq $section $url_trimmed) }} active{{end}}">{{ .Name }}</a> - {{ end }} - <a href="https://discourse.opengeosys.org" class="nav-item">Discourse</a> + {{ end }} + <a href="https://discourse.opengeosys.org" class="nav-item">Discourse</a> </div> <div class="w-1/4"> {{ partial "site-search.html" . }} diff --git a/web/layouts/section/docs.html b/web/layouts/section/docs.html index 19aefe3d0df5984bb5507a3d76cfac2423148daa..54aeffa324db949ba512f11206af671345a98afb 100644 --- a/web/layouts/section/docs.html +++ b/web/layouts/section/docs.html @@ -1,19 +1,26 @@ {{ define "main" }} <div class="container"> - {{ if ne .CurrentSection.RelPermalink "/docs/" }} - <h2>{{ .CurrentSection.Title }} - All pages</h2> - <ul> - {{ range .Pages }} - <li><a href="{{ .Permalink }}">{{ .Title }}</a></li> - {{ end }} - </ul> - {{ else }} <!-- /docs --> <div class="flex flex-wrap w-full mb-4 flex-col items-center text-center"> {{ .Content }} </div> - <div class="flex flex-wrap -m-4"> + {{ range .Site.Menus.docs }} + <div class="xl:w-1/3 md:w-1/2 p-4 my-3"> + <div class="border border-gray-300 p-6 rounded-lg h-full"> + <h2 class="text-lg text-gray-900 font-medium title-font mb-2"> + <a href="{{ .URL }}"> + {{ .Name }} + {{ $url_first_char := substr .URL 0 1 }} + {{ if not (eq $url_first_char "/") }} + <i class="far fa-external-link text-xs align-top"></i> + {{ end }} + </a> + </h2> + <p class="leading-relaxed text-base">{{ .Post }}</p> + </div> + </div> + {{ end }} {{ range .Params.sections }} <div class="xl:w-1/3 md:w-1/2 p-4 my-3"> <div class="border border-gray-300 p-6 rounded-lg h-full"> @@ -31,6 +38,5 @@ </div> {{ end }} </div> - {{ end }} </div> {{ end }} diff --git a/web/layouts/section/publications.html b/web/layouts/section/publications.html index 96e8c6da634f6637a72ce65e221e2a6ad71faff6..1bc174810b3f6f06188fb5d2b7d1f3e45a0b1389 100644 --- a/web/layouts/section/publications.html +++ b/web/layouts/section/publications.html @@ -4,19 +4,19 @@ {{ .Content }} </div> <div class="flex flex-wrap -m-4"> - {{ range .Params.sections }} + {{ range .Site.Menus.publications }} <div class="xl:w-1/3 md:w-1/2 p-4 my-3"> <div class="border border-gray-300 p-6 rounded-lg h-full"> <h2 class="text-lg text-gray-900 font-medium title-font mb-2"> - <a href="{{ .url }}"> - {{ .name }} - {{ $url_first_char := substr .url 0 1 }} + <a href="{{ .URL }}"> + {{ .Name }} + {{ $url_first_char := substr .URL 0 1 }} {{ if not (eq $url_first_char "/") }} <i class="far fa-external-link text-xs align-top"></i> {{ end }} </a> </h2> - <p class="leading-relaxed text-base">{{ .text }}</p> + <p class="leading-relaxed text-base">{{ .Post }}</p> </div> </div> {{ end }}