Skip to content
Snippets Groups Projects

Update text on landingpage

Merged Martin Schroschk requested to merge landingpage into preview
1 file
+ 6
25
Compare changes
  • Side-by-side
  • Inline
@@ -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)
Loading