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
561940ed
Commit
561940ed
authored
3 years ago
by
Ulf Markwardt
Browse files
Options
Downloads
Patches
Plain Diff
Update contribute_container.md
parent
484a2098
No related branches found
No related tags found
3 merge requests
!322
Merge preview into main
,
!319
Merge preview into main
,
!300
Contrib container
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
contribute_container.md
+1
-71
1 addition, 71 deletions
contribute_container.md
with
1 addition
and
71 deletions
contribute_container.md
+
1
−
71
View file @
561940ed
# Contributing Using Local Docker Container
# Contributing Using
a
Local
Clone and a
Docker Container
## Prerequisites
...
...
@@ -6,25 +6,6 @@ Assuming you have:
*
A system with running Docker installation
*
All necessary access/execution rights
# Contribution Guide
In the following, it is outlined how to contribute to the
[
HPC documentation
](
https://doc.zih.tu-dresden.de/
)
of
[
TU Dresden/ZIH
](
https://tu-dresden.de/zih/
)
and
which rules should be followed when adding to this project. Although, this document might seem very
long describing complex steps, contributing is quite easy - trust us.
## Contribute via Issue
Users can contribute to the documentation via the
[
issue tracking system
](
https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/issues
)
.
For that, open an issue to report typos and missing documentation or request for more precise
wording etc. ZIH staff will get in touch with you to resolve the issue and improve the
documentation.
**Reminder:**
Non-documentation issues and requests need to be send as ticket to
[
hpcsupport@zih.tu-dresden.de
](
mailto:hpcsupport@zih.tu-dresden.de
)
.
## Preparation
Contributions can be done via editing the repository through GitLab's web interface or following
...
...
@@ -46,37 +27,6 @@ Now, create a local clone of your fork
~ https://gitlab.hrz.tu-chemnitz.de/LOGIN/hpc-compendium.git
```
#### Install Dependencies
**TODO:**
Description
```
Shell Session
~ cd hpc-compendium/doc.zih.tu-dresden.de
~ pip install -r requirements.txt
```
**TODO:**
virtual environment
**TODO:**
What we need for markdownlinter and checks?
<!--- All branches are protected, i.e., only ZIH staff can create branches and push to them --->
## Contribute via Web IDE
GitLab offers a rich and versatile web interface to work with repositories. To fix typos and edit
source files, just select the file of interest and click the
`Edit`
button. A text and commit
editor are invoked: Do your changes, add a meaningful commit message and commit the changes.
The more sophisticated integrated Web IDE is reached from the top level menu of the repository or
by selecting any source file.
Other git services might have an equivalent web interface to interact with the repository. Please
refer to the corresponding documentation for further information.
<!--This option of contributing is only available for users of-->
<!--[gitlab.hrz.tu-chemnitz.de](https://gitlab.hrz.tu-chemnitz.de). Furthermore, -->
## Contribute via Local Clone
### mkdocs Rocks
As mentioned, this documentation bases on markdown files which are translated into static html files
...
...
@@ -97,26 +47,6 @@ To make use of `mkdocs`, it is necessary to have two commands in mind
~ mkdocs build - Build the documentation site.
```
#### Preview Using mkdocs
Invoke
`mkdocs serve`
to build and preview the documentation. The documentation is automatically
rerendered and reloaded if the system detects updates (great!). By default, the builtin web server
hosts the documentation at
`http://127.0.0.1:8000`
.
```
Shell Session
~ cd /PATH/TO/hpc-compendium/doc.zih.tu-dresden.de
~ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
INFO - Documentation built in 0.08 seconds
[I 210127 13:33:30 server:335] Serving on http://127.0.0.1:8000
INFO - Serving on http://127.0.0.1:8000
[I 210127 13:33:30 handlers:62] Start watching changes
INFO - Start watching changes
```
Open
`http://127.0.0.1:8000`
with a web browser to preview the local copy of the documentation.
#### Preview Using mkdocs With Dockerfile
You can also use
`docker`
to build a container from the
`Dockerfile`
, if you are familiar with it.
...
...
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