From 6fc236777d3f16a9d82a31803a24b7f98b664c81 Mon Sep 17 00:00:00 2001 From: Danny Marc Rotscher <danny.rotscher@tu-dresden.de> Date: Mon, 3 May 2021 12:02:13 +0000 Subject: [PATCH] Changed start page for HPC-Wiki 2.0 --- doc.zih.tu-dresden.de/docs/index.md | 43 ++++------------------------- 1 file changed, 6 insertions(+), 37 deletions(-) diff --git a/doc.zih.tu-dresden.de/docs/index.md b/doc.zih.tu-dresden.de/docs/index.md index 5bacfa737..dc121cc7b 100644 --- a/doc.zih.tu-dresden.de/docs/index.md +++ b/doc.zih.tu-dresden.de/docs/index.md @@ -1,44 +1,13 @@ # ZIH HPC Compendium -Dear visitor , +Dear HPC users, -this is a proposal for the next generation of technical documentation for the HPC systems and -services at ZIH / TU Dresden. +due to restrictions coming from data security and software incompatibilities the old "HPC Compendium" is now reachable only from inside TU Dresden campus (or via VPN). -## Status +Internal users should be redirected automatically to the [internal IP address](https://141.76.17.11/hpc-wiki/bin/view/Compendium). -The project (repository and the documentation) is a mock-up of the proposed technical workflow as -well as restructured content and topics. +We apologize for this severe action, but we are in the middle of the preparation for a wiki relaunch, so we do not want to redirect resources to fix technical/security issues for a system that will last only a few weeks. -## What is new? +Thank you for your understanding, -The desire for a new technical documentation is driven by two major aspects: - -1. Clear and user-oriented structure of the content -1. Usage of modern tools for technical documentation - -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. - -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 -repository. The generated static html files, i.e, the documentation you are now reading, is deployed -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. +your HPC Support Team ZIH -- GitLab