Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
hpc-compendium
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ZIH
hpcsupport
hpc-compendium
Commits
d21d05b4
Commit
d21d05b4
authored
3 years ago
by
Martin Schroschk
Browse files
Options
Downloads
Patches
Plain Diff
Update text on landingpage
parent
ebf645fa
No related branches found
No related tags found
3 merge requests
!322
Merge preview into main
,
!319
Merge preview into main
,
!134
Update text on landingpage
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc.zih.tu-dresden.de/docs/index.md
+6
-25
6 additions, 25 deletions
doc.zih.tu-dresden.de/docs/index.md
with
6 additions
and
25 deletions
doc.zih.tu-dresden.de/docs/index.md
+
6
−
25
View file @
d21d05b4
...
@@ -16,19 +16,7 @@ Thank you for your understanding,
...
@@ -16,19 +16,7 @@ Thank you for your understanding,
your HPC Support Team ZIH
your HPC Support Team ZIH
## NGS ZIH HPC Compendium
## What is new?
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?
The desire for a new technical documentation is driven by two major aspects:
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:
...
@@ -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
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
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
i
s a nightmare.
quite messy, and housekeeping it
wa
s a nightmare.
The new structure is designed with the schedule for an HPC project in mind. This will ease the start
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.
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
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
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
from this markdown files. All configuration, layout and content files are managed within a git
...
@@ -53,15 +38,11 @@ to a web server.
...
@@ -53,15 +38,11 @@ to a web server.
The workflow is flexible, allows a high level of automation, and is quite easy to maintain.
The workflow is flexible, allows a high level of automation, and is quite easy to maintain.
### Mock-Up
From a technical point, our new documentation system is highly inspired by
[
OLFC User Documentation
](
https://docs.olcf.ornl.gov/
)
as well as
This mock-up makes use of the two GitLab features
[
GitLab Runner
](
https://docs.gitlab.com/runner/
)
[
NERSC Technical Documentation
](
https://nersc.gitlab.io/
)
.
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.
##
#
Contribute
## Contribute
Contributions are highly welcome. Please refere to
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
)
[
README.md
](
https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/blob/main/doc.zih.tu-dresden.de/README.md
)
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment