diff --git a/web/content/docs/_index.md b/web/content/docs/_index.md index 474756d23c90c4309384afc6649485491ecdbe14..097b06c9638153ce76750b05042417dd38da1ee2 100644 --- a/web/content/docs/_index.md +++ b/web/content/docs/_index.md @@ -3,22 +3,42 @@ title = "Documentation" [[sections]] name = "Quickstart" -slug = "quickstart" +url = "/docs/quickstart" text = "Download, install and run an OGS benchmark in 5 minutes! No development setup required." [[sections]] name = "Developer Guide" -slug = "devguide" +url = "/docs/devguide" 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." [[sections]] name = "Selected Benchmarks" -slug = "benchmarks" +url = "/docs/benchmarks" text = "Basic benchmarks are explained and input files are provided to get you started in using OGS." [[sections]] name = "Tools" -slug = "tools" +url = "/docs/tools" text = "Helpful tools for pre- and postprocessing." +[[sections]] +name = "Data Explorer Manual" +url = "https://jenkins.opengeosys.org/job/ufz/job/data_explorer_manual/job/master/lastSuccessfulBuild/artifact/DataExplorer-Manual.pdf" +text = "Manual for the graphical user interface for OpenGeoSys, the Data Explorer." + +[[sections]] +name = "Source code documentation" +url = "http://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." + +[[sections]] +name = "Styleguide" +url = "http://ufz.github.io/styleguide/cppguide.xml" +text = "OpenGeoSys C++ Style Guide" + +[[sections]] +name = "Mailing List" +url = "https://groups.google.com/forum/#!forum/ogs-users" +text = "The mailing lists for OpenGeoSys users and developers are a good place to ask question related to anything OGS." + +++ diff --git a/web/layouts/section/docs.html b/web/layouts/section/docs.html index a0c3bff7704d30b53bc1024c1dd2e36b49a182bd..caf89f358bd15535d36b849fc18ba00ef420e681 100644 --- a/web/layouts/section/docs.html +++ b/web/layouts/section/docs.html @@ -3,16 +3,23 @@ {{ .Content }} <div class="flex flex-wrap"> {{ range .Params.sections }} - <div class="w-1/3 p-2 my-3"> + <div class="w-full sm:w-1/2 lg:w-1/3 p-2 my-3"> <div class="p-2"> <div class="tc"> - <h2 class="text-center"><a href="/docs/{{ .slug }}">{{ .name }}</a></h1> + <h2 class="text-center"> + <a href="{{ .url }}"> + {{ .name }} + {{ $url_first_char := substr .url 0 1 }} + {{ if not (eq $url_first_char "/") }} + <i class="text-xs align-top fas fa-external-link-alt"></i> + {{ end }} + </a> + </h1> <hr> </div> <p class="1h-copy measure center f6 black-70">{{ .text }}</p> </div> </div> - {{ end }} </div>