From 44f81d34e18a30388276ae762010e27db40cdb87 Mon Sep 17 00:00:00 2001
From: Martin Schroschk <martin.schroschk@tu-dresden.de>
Date: Thu, 15 Jul 2021 14:28:00 +0200
Subject: [PATCH] Resolve issue !28
---
.../docs/access/{access.md => overview.md} | 2 +-
.../{application.md => overview.md} | 2 +-
.../docs/archive/overview.md | 5 ++++
.../{data_management.md => overview.md} | 2 +-
.../{data_moving.md => overview.md} | 0
.../{use_of_hardware.md => overview.md} | 2 +-
...plications.md => applications_overview.md} | 2 +-
.../docs/software/overview.md | 2 +-
...nt.md => software_development_overview.md} | 2 +-
doc.zih.tu-dresden.de/mkdocs.yml | 25 ++++++++++---------
10 files changed, 25 insertions(+), 19 deletions(-)
rename doc.zih.tu-dresden.de/docs/access/{access.md => overview.md} (97%)
rename doc.zih.tu-dresden.de/docs/application/{application.md => overview.md} (88%)
create mode 100644 doc.zih.tu-dresden.de/docs/archive/overview.md
rename doc.zih.tu-dresden.de/docs/data_lifecycle/{data_management.md => overview.md} (99%)
rename doc.zih.tu-dresden.de/docs/data_transfer/{data_moving.md => overview.md} (100%)
rename doc.zih.tu-dresden.de/docs/jobs_and_resources/{use_of_hardware.md => overview.md} (99%)
rename doc.zih.tu-dresden.de/docs/software/{applications.md => applications_overview.md} (98%)
rename doc.zih.tu-dresden.de/docs/software/{software_development.md => software_development_overview.md} (98%)
diff --git a/doc.zih.tu-dresden.de/docs/access/access.md b/doc.zih.tu-dresden.de/docs/access/overview.md
similarity index 97%
rename from doc.zih.tu-dresden.de/docs/access/access.md
rename to doc.zih.tu-dresden.de/docs/access/overview.md
index 15ff4d420..e324c4cad 100644
--- a/doc.zih.tu-dresden.de/docs/access/access.md
+++ b/doc.zih.tu-dresden.de/docs/access/overview.md
@@ -1,4 +1,4 @@
-# Access to the cluster
+# Access to the Cluster
## SSH access
diff --git a/doc.zih.tu-dresden.de/docs/application/application.md b/doc.zih.tu-dresden.de/docs/application/overview.md
similarity index 88%
rename from doc.zih.tu-dresden.de/docs/application/application.md
rename to doc.zih.tu-dresden.de/docs/application/overview.md
index ed66ce572..5a7644da0 100644
--- a/doc.zih.tu-dresden.de/docs/application/application.md
+++ b/doc.zih.tu-dresden.de/docs/application/overview.md
@@ -1,4 +1,4 @@
-# Application for HPC Login
+# Application for Login and Resources
In order to use the HPC systems installed at ZIH, a project application form has to be filled in.
The HPC project manager should hold a professorship (university) or head a research group. You may
diff --git a/doc.zih.tu-dresden.de/docs/archive/overview.md b/doc.zih.tu-dresden.de/docs/archive/overview.md
new file mode 100644
index 000000000..42491b1f3
--- /dev/null
+++ b/doc.zih.tu-dresden.de/docs/archive/overview.md
@@ -0,0 +1,5 @@
+# Archive
+
+A warm welcome to the *archive*. You probably got here by following a link from within the compendium.
+The archive holds outdated documentation for future reference. Documentation in the archive, is not
+further updated.
diff --git a/doc.zih.tu-dresden.de/docs/data_lifecycle/data_management.md b/doc.zih.tu-dresden.de/docs/data_lifecycle/overview.md
similarity index 99%
rename from doc.zih.tu-dresden.de/docs/data_lifecycle/data_management.md
rename to doc.zih.tu-dresden.de/docs/data_lifecycle/overview.md
index 598fd816f..902a6caec 100644
--- a/doc.zih.tu-dresden.de/docs/data_lifecycle/data_management.md
+++ b/doc.zih.tu-dresden.de/docs/data_lifecycle/overview.md
@@ -1,4 +1,4 @@
-# Create a Project Structure / Data Management
+# Data Lifecycle Management
Correct organisation of the project structure is a straightforward way to the efficient work of the
whole team. There have to be rules and regulations for working with the project that every member
diff --git a/doc.zih.tu-dresden.de/docs/data_transfer/data_moving.md b/doc.zih.tu-dresden.de/docs/data_transfer/overview.md
similarity index 100%
rename from doc.zih.tu-dresden.de/docs/data_transfer/data_moving.md
rename to doc.zih.tu-dresden.de/docs/data_transfer/overview.md
diff --git a/doc.zih.tu-dresden.de/docs/jobs_and_resources/use_of_hardware.md b/doc.zih.tu-dresden.de/docs/jobs_and_resources/overview.md
similarity index 99%
rename from doc.zih.tu-dresden.de/docs/jobs_and_resources/use_of_hardware.md
rename to doc.zih.tu-dresden.de/docs/jobs_and_resources/overview.md
index a12b26c37..c48a7f41b 100644
--- a/doc.zih.tu-dresden.de/docs/jobs_and_resources/use_of_hardware.md
+++ b/doc.zih.tu-dresden.de/docs/jobs_and_resources/overview.md
@@ -1,4 +1,4 @@
-# Use of Hardware
+# Jobs and Resources
To run the software, do some calculations or compile your code compute nodes have to be used. Login
nodes which are using for login can not be used for your computations. Submit your tasks (by using
diff --git a/doc.zih.tu-dresden.de/docs/software/applications.md b/doc.zih.tu-dresden.de/docs/software/applications_overview.md
similarity index 98%
rename from doc.zih.tu-dresden.de/docs/software/applications.md
rename to doc.zih.tu-dresden.de/docs/software/applications_overview.md
index 7a939447e..6a6123597 100644
--- a/doc.zih.tu-dresden.de/docs/software/applications.md
+++ b/doc.zih.tu-dresden.de/docs/software/applications_overview.md
@@ -1,4 +1,4 @@
-# Installed Applications
+# Applications
The following applications are available on the HRSK systems. (General
descriptions are taken from the vendor's web site or from
diff --git a/doc.zih.tu-dresden.de/docs/software/overview.md b/doc.zih.tu-dresden.de/docs/software/overview.md
index dbb75ca85..874f8ad2c 100644
--- a/doc.zih.tu-dresden.de/docs/software/overview.md
+++ b/doc.zih.tu-dresden.de/docs/software/overview.md
@@ -1,4 +1,4 @@
-# Overview
+# Environment and Software
According to [What software do I need]**todo link**, first of all, check the [Software module
list]**todo link**. Keep in mind that there are two different environments: **scs5** (for the x86
diff --git a/doc.zih.tu-dresden.de/docs/software/software_development.md b/doc.zih.tu-dresden.de/docs/software/software_development_overview.md
similarity index 98%
rename from doc.zih.tu-dresden.de/docs/software/software_development.md
rename to doc.zih.tu-dresden.de/docs/software/software_development_overview.md
index 28fd208e9..dc55ba6c6 100644
--- a/doc.zih.tu-dresden.de/docs/software/software_development.md
+++ b/doc.zih.tu-dresden.de/docs/software/software_development_overview.md
@@ -1,4 +1,4 @@
-# Software Development at HPC Systems
+# Software Development and Tools
This section provides you with the basic knowledge and tools to get you out of trouble. It will tell
you:
diff --git a/doc.zih.tu-dresden.de/mkdocs.yml b/doc.zih.tu-dresden.de/mkdocs.yml
index 59f841162..50bad6491 100644
--- a/doc.zih.tu-dresden.de/mkdocs.yml
+++ b/doc.zih.tu-dresden.de/mkdocs.yml
@@ -1,24 +1,24 @@
nav:
- Home: index.md
- Application for Login and Resources:
- - Overview: application/application.md
+ - Overview: application/overview.md
- Access: application/access.md
- Terms: application/terms_of_use.md
- Request for Resources: application/request_for_resources.md
- Project Request Form: application/project_request_form.md
- Project Management: application/project_management.md
- Access to the Cluster:
- - Overview: access/access.md
+ - Overview: access/overview.md
- Desktop Visualization: access/desktop_cloud_visualization.md
- Web VNC: access/web_vnc.md
- Login: access/login.md
- Security Restrictions: access/security_restrictions.md
- SSH with Putty: access/ssh_mit_putty.md
- JupyterHub:
- - Overview: ../../access/jupyterhub.md
- - JupyterHub for Teaching: ../../access/jupyterhub_for_teaching.md
+ - JupyterHub: access/jupyterhub.md
+ - JupyterHub for Teaching: access/jupyterhub_for_teaching.md
- Transfer of Data:
- - Overview: data_transfer/data_moving.md
+ - Overview: data_transfer/overview.md
- Data Mover: data_transfer/data_mover.md
- Export Nodes: data_transfer/export_nodes.md
- Environment and Software:
@@ -33,7 +33,7 @@ nav:
- Singularity Example Definitions: software/singularity_example_definitions.md
- VM tools: software/vm_tools.md
- Applications:
- - Overview: software/applications.md
+ - Overview: software/applications_overview.md
- Bio Informatics: software/bioinformatics.md
- Computational Fluid Dynamics (CFD): software/cfd.md
- Nanoscale Simulations: software/nanoscale_simulations.md
@@ -57,7 +57,7 @@ nav:
- Virtual Machines: software/virtual_machines.md
- Virtual Desktops: software/virtual_desktops.md
- Software Development and Tools:
- - Overview: software/software_development.md
+ - Overview: software/software_development_overview.md
- Building Software: software/building_software.md
- GPU Programming: software/gpu_programming.md
- Compilers: software/compilers.md
@@ -71,7 +71,7 @@ nav:
- Vampir: software/vampir.md
- Mathematics: software/mathematics.md
- Data Lifecycle Management:
- - Overview: data_lifecycle/data_management.md
+ - Overview: data_lifecycle/overview.md
- Quotas: data_lifecycle/quotas.md
- Workspaces: data_lifecycle/workspaces.md
- BeeGFS: data_lifecycle/bee_gfs.md
@@ -82,7 +82,7 @@ nav:
- Preservation of Research Data: data_lifecycle/preservation_research_data.md
- Structuring Experiments: data_lifecycle/experiments.md
- Jobs and Resources:
- - Overview: jobs_and_resources/use_of_hardware.md
+ - Overview: jobs_and_resources/overview.md
- Batch Systems: jobs_and_resources/batch_systems.md
- Hardware Resources:
- Hardware Taurus: jobs_and_resources/hardware_taurus.md
@@ -109,6 +109,7 @@ nav:
#- Tests: tests.md
- Support: support.md
- Archive:
+ - Overview: archive/overview.md
- CXFS End of Support: archive/cxfs_end_of_support.md
- Debugging Tools: archive/debugging_tools.md
- Hardware: archive/hardware.md
@@ -139,13 +140,13 @@ nav:
# Project Information
-site_name: ZIH HPC Compendium 2.0
-site_description: ZIH HPC Compendium 2.0
+site_name: ZIH HPC Compendium
+site_description: ZIH HPC Compendium
site_author: ZIH Team
site_dir: public
site_url: https://gitlab.hrz.tu-chemnitz.de/hpcsupport/hpc-compendium
# uncomment next 3 lines if link to repo should not be displayed in the navbar
-repo_name: GitLab hpcsupport/hpc-compendium
+repo_name: GitLab hpc-compendium
repo_url: https://gitlab.hrz.tu-chemnitz.de/hpcsupport/hpc-compendium
edit_uri: blob/master/docs/
--
GitLab