From d21d05b4b9c1ba08cb420326a0c31ca2c58cbd55 Mon Sep 17 00:00:00 2001 From: Martin Schroschk <martin.schroschk@tu-dresden.de> Date: Thu, 1 Jul 2021 09:36:14 +0200 Subject: [PATCH] Update text on landingpage --- doc.zih.tu-dresden.de/docs/index.md | 31 ++++++----------------------- 1 file changed, 6 insertions(+), 25 deletions(-) diff --git a/doc.zih.tu-dresden.de/docs/index.md b/doc.zih.tu-dresden.de/docs/index.md index 5cd74f0a2..caa05b3d9 100644 --- a/doc.zih.tu-dresden.de/docs/index.md +++ b/doc.zih.tu-dresden.de/docs/index.md @@ -16,19 +16,7 @@ Thank you for your understanding, your HPC Support Team ZIH -## NGS ZIH HPC Compendium - -Dear visitor, - -this is a proposal for the next generation of technical documentation for the HPC systems and -services at ZIH / TU Dresden. - -### Status - -The project (repository and the documentation) is a mock-up of the proposed technical workflow as -well as restructured content and topics. - -### What is new? +## What is new? The desire for a new technical documentation is driven by two major aspects: @@ -37,14 +25,11 @@ The desire for a new technical documentation is driven by two major aspects: The HPC Compendium provided knowledge and help for many years. It grew with every new hardware installation and ZIH stuff tried its best to keep it up to date. But, to be honest, it has become -quite messy, and housekeeping it is a nightmare. +quite messy, and housekeeping it was a nightmare. The new structure is designed with the schedule for an HPC project in mind. This will ease the start for new HPC users, as well speedup searching information w.r.t. a specific topic for advanced users. -From a technical point, our new documentation system is highly inspired by [OLFC User -Documentation](https://docs.olcf.ornl.gov/) as well as [NERSC Technical -Documentation](https://nersc.gitlab.io/). We decided against a classical wiki software. Instead, we write the documentation in markdown and make use of the static site generator [mkdocs](https://www.mkdocs.org/) to create static html files from this markdown files. All configuration, layout and content files are managed within a git @@ -53,15 +38,11 @@ to a web server. The workflow is flexible, allows a high level of automation, and is quite easy to maintain. -### Mock-Up - -This mock-up makes use of the two GitLab features [GitLab Runner](https://docs.gitlab.com/runner/) -and [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/). -Using GitLab Pages static websites can be directly published from a repository in GitLab. GitLab -Runner is an application that works with GitLab CI/CD to run jobs in a pipeline. The CI/CD pipeline -for this very project is to generate the static html using `mkdocs` and deploy them at GitLab Pages. +From a technical point, our new documentation system is highly inspired by +[OLFC User Documentation](https://docs.olcf.ornl.gov/) as well as +[NERSC Technical Documentation](https://nersc.gitlab.io/). -### Contribute +## Contribute Contributions are highly welcome. Please refere to [README.md](https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/blob/main/doc.zih.tu-dresden.de/README.md) -- GitLab