[web] Added quickstart section.

web/config.toml

@@ -8,7 +8,7 @@ enableGitInfo = true
 canonifyURLs = true
 
 [params]
-  # alert = "Benchmarks only documentation; the Developer Guide can be found at <a href='https://docs.opengeosys.org'>docs.opengeosys.org</a>."
+  alert = "Documentation site under construction; more docs can be found at <a href='https://docs.opengeosys.org'>docs.opengeosys.org</a>."
 
 [taxonomies]
 news = "news"
@@ -89,3 +89,9 @@ news = "news"
   name = "Two-phase Flow"
   identifier = "two-phase-flow"
   weight = 8
+
+# Quickstart sidebar top-level categories
+[[menu.quickstart]]
+  name = "Basics"
+  identifier = "basics"
+  weight = 1

web/content/docs/_index.md

 +++
 title = "Documentation"
 
+[[sections]]
+name = "Quickstart"
+slug = "quickstart"
+text = "Download, install and run an OGS benchmark in 5 minutes! No development setup required."
+
 [[sections]]
 name = "Developer Guide"
 slug = "devguide"

web/content/docs/benchmarks/elliptic/groundwater-flow-dirichlet-nodal-source-term.md

@@ -3,9 +3,7 @@ date = "2017-02-15T11:17:39+01:00"
 title = "Groundwater Flow (Nodal Source Term)"
 project = "Elliptic/circle_radius_1/circle_1e6_axi.prj"
 author = "Thomas Fischer"
-weight = 105
-
-aliases = [ "/docs/benchmarks/" ] # First benchmark page
+weight = 104
 
 [menu]
   [menu.benchmarks]

web/content/docs/benchmarks/elliptic/groundwater-flow-robin.md

@@ -6,9 +6,7 @@ author = "Dmitri Naumov"
 weight = 104
 
 [menu]
-
   [menu.benchmarks]
-    #weight = 103
     parent = "elliptic"
 
 +++

web/content/docs/quickstart/basics/envinf1.pandoc

++++
+date = "2018-02-27T11:00:13+01:00"
+title = "Eve / envinf1"
+author = "Lars Bilke"
+weight = 2
+
+[menu]
+  [menu.quickstart]
+    parent = "basics"
++++
+
+## Introduction
+
+Members of the Department Environmental Informatics of the Helmholtz Centre for Environmental Research - UFZ can use the `envinf1`, `frontend1` and `frontend2`-machines which are tightly connected to the Eve cluster system.
+
+## Select OGS version
+
+You select an OGS version by loading a module:
+
+```bash
+export MODULEPATH=$MODULEPATH:/global/apps/modulefiles
+
+# Examples:
+module load ogs            # Loads latest (maybe unstable) ogs in standard config
+module load ogs/head/petsc # Loads latest (maybe unstable) petsc config
+module load ogs/6.0.9      # Loads stable version 6.0.9 in standard config, not released yet
+```
+
+You can select only one version at a time. Run `module purge` to unload all previously loaded modules.
+
+See [Quickstart]({{< relref "introduction.pandoc" >}}) for running instructions.

web/content/docs/quickstart/basics/introduction.pandoc

++++
+date = "2018-02-27T11:00:13+01:00"
+title = "Introduction"
+author = "Lars Bilke"
+weight = 1
+
+aliases = [ "/docs/quickstart/" ]
+
+[menu]
+  [menu.quickstart]
+    parent = "basics"
++++
+
+## Download
+
+Download the latest release of OpenGeoSys from the [Download](https://docs.opengeosys.org/download)-page. Be sure to pick the correct file for your operating system.
+
+## Installation
+
+OGS itself is a simple executable file so you can put it anywhere you like. For convenience you may put into a location which is in your `PATH`-environment variable which allows you to start the executable without specifying its full file path.
+
+## Download benchmarks
+
+Download the latest benchmark files from [GitHub as a .zip-package](https://github.com/ufz/ogs-data/archive/master.zip). Unzip it. See [the Benchmarks section](/docs/benchmarks/) for more information.
+
+## Running
+
+OGS is a command line application and requires the path to a `.prj`-file as an argument.
+
+::: {.win}
+To run it open a new command line shell (called *cmd.exe*). Now simply type `ogs` (if the executable is in your `PATH`-environment variable) or specify its full path (e.g.: `C:\Users\MyUserName\Downloads\ogs.exe`) and hit `ENTER`.
+
+OGS prints out its usage instructions:
+
+```
+PARSE ERROR:
+             Required argument missing: project-file
+
+Brief USAGE:
+   ogs  [--] [--version] [-h] <PROJECT FILE>
+
+For complete USAGE and HELP type:
+   ogs --help
+```
+
+You can see that there is the project-file missing.
+
+Then simply supply the path to a project file as an argument to the OGS executable:
+
+```
+$ ogs .\Path\to\BenchmarkName.prj
+```
+:::
+
+::: {.linux}
+To run it open a new command line shell (*Terminal*). Now simply type `ogs` (if the executable is in your `PATH`-environment variable) or specify its full path (e.g.: `./path/to/ogs`) and hit `ENTER`.
+
+OGS prints out its usage instructions:
+
+```
+PARSE ERROR:
+             Required argument missing: project-file
+
+Brief USAGE:
+   ogs  [--] [--version] [-h] <PROJECT FILE>
+
+For complete USAGE and HELP type:
+   ogs --help
+```
+
+You can see that there is the project-file missing.
+
+Then simply supply the path to a project file as an argument to the OGS executable:
+
+```
+$ ogs ./path/to/BenchmarkName.prj
+```
+:::
+
+::: {.mac}
+See Linux tab!
+:::

web/layouts/docs/single.html

@@ -4,8 +4,11 @@
     {{ $segments := split .RelPermalink "/" }}
     {{ $subsection := index $segments 2 }}
     <h3>
+      <a href="/docs/">Docs</a> / <span class="orange">
       {{ if eq $subsection "devguide"}}Developer Guide{{ end }}
       {{ if eq $subsection "benchmarks"}}Benchmarks{{ end }}
+      {{ if eq $subsection "quickstart"}}Quickstart{{ end }}
+      </span>
     </h3>
     <hr>
     <ul class="sidenav">
@@ -23,7 +26,7 @@
   </div>
   <div class="col-xs-9">
     <h1>{{ .Title }}</h1>
-    {{ if eq $subsection "devguide"}}
+    {{ if or (eq $subsection "devguide") (eq $subsection "quickstart") }}
     <div id="os-selector">Select OS: <a id="btn-win"><i class="fab fa-windows"></i> Windows</a> <a id="btn-linux"><i class="fab fa-linux"></i> Linux</a> <a id="btn-mac"><i class="fab fa-apple"></i> macOS</a></div>
     {{ end }}
 
@@ -41,7 +44,7 @@
 
   {{ $segments := split .RelPermalink "/" }}
   {{ $subsection := index $segments 2 }}
-  {{ if eq $subsection "devguide"}}
+  {{ if or (eq $subsection "devguide") (eq $subsection "quickstart") }}
   <script>
     $("#btn-win").click(function(){
       $(".win").show();

web/layouts/index.html

 {{ define "main" }}
-
-  <div class="col-xs-4">
-    <h2>Content</h2>
-    <ul>
-    {{ range .Site.Sections }}
-        {{ if not (eq .Title "Internals")}}
-            <li><a href="{{ .Permalink }}">{{ .Title }}</a></li>
-        {{ end }}
-    {{ end }}
-    {{ range .Data.Pages }}
-      {{ if eq .Type "page" }}
-        <li><a href="{{ .Permalink }}">{{ .Title }}</a></li>
-      {{ end }}
-    {{ end }}
-    <li><a href="/news">News</a></li>
-  </div>
-
-  <div class="col-xs-8">
-    <h1>Documentation site under construction</h1>
-    <p>For the moment this site contains just the <a href="/docs/benchmarks"><i class="fas fa-arrow-right"></i> benchmark documentation</a> for <a href="https://github.com/ufz/ogs6">OpenGeoSys-6</a>.
-    </p>
-  </div>
-
+<div class="col-xs-8">
+    {{.Content}}
+</div>
 {{ end }}

web/layouts/section/docs.html

@@ -4,16 +4,20 @@
     <h1>OpenGeoSys Documentation</h1>
     {{ .Content }}
     <div class="row">
+      <div class="flex flex-wrap">
       {{ range .Params.sections }}
-        <article class="fl w-33 ma2 bg-white br3 pa4 pa4-ns mv3 ba b--black-10">
-          <div class="tc">
-            <h1 class="f4"><a href="/docs/{{ .slug }}">{{ .name }}</a></h1>
-            <hr class="mw3 bb bw1 b--black-10">
+        <div class="w-third pa2 mv3">
+          <div class="pa2 ba br3 b--black-10">
+            <div class="tc">
+              <h1 class="f4"><a href="/docs/{{ .slug }}">{{ .name }}</a></h1>
+              <hr class="mw3 bb bw1 b--black-10">
+            </div>
+            <p class="1h-copy measure center f6 black-70">{{ .text }}</p>
           </div>
-          <p class="1h-copy measure center f6 black-70">{{ .text }}</p>
-        </article>
+        </div>
 
       {{ end }}
+      </div>
     </div>
   </div>