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
9b336444
Commit
9b336444
authored
3 years ago
by
Ulf Markwardt
Browse files
Options
Downloads
Patches
Plain Diff
Update contribute_container.md
parent
170ae8bb
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
+4
-1
4 additions, 1 deletion
contribute_container.md
with
4 additions
and
1 deletion
contribute_container.md
+
4
−
1
View file @
9b336444
...
@@ -22,6 +22,7 @@ Here is a suggestion of a workflow which might be suitable for you.
...
@@ -22,6 +22,7 @@ Here is a suggestion of a workflow which might be suitable for you.
### Start the Local Web Server
### Start the Local Web Server
The command(s) to start the dockerized web server is this:
The command(s) to start the dockerized web server is this:
```
```
docker run --name=hpc-compendium -p 8000:8000 --rm -it -w /docs -v /tmp/hpc-compendium/doc.zih.tu-dresden.de:/docs:z hpc-compendium bash -c 'mkdocs build && mkdocs serve -a 0.0.0.0:8000'
docker run --name=hpc-compendium -p 8000:8000 --rm -it -w /docs -v /tmp/hpc-compendium/doc.zih.tu-dresden.de:/docs:z hpc-compendium bash -c 'mkdocs build && mkdocs serve -a 0.0.0.0:8000'
```
```
...
@@ -40,7 +41,8 @@ With the details described below, it will then be easy to follow the guidelines
...
@@ -40,7 +41,8 @@ With the details described below, it will then be easy to follow the guidelines
(Remember to keep the local web server running in the other shell.)
(Remember to keep the local web server running in the other shell.)
First, change to the
`hpc-compendium`
directory and set the environment variable DC to save a lot of keystrokes :-)
First, change to the
`hpc-compendium`
directory and set the environment variable DC to save a lot of keystrokes :-)
```
```
Bash
DC='docker exec -it hpc-compendium bash -c '
DC='docker exec -it hpc-compendium bash -c '
```
```
and use it like this...
and use it like this...
...
@@ -56,6 +58,7 @@ $DC 'markdownlint docs'
...
@@ -56,6 +58,7 @@ $DC 'markdownlint docs'
#### Link Checker
#### Link Checker
To check a single file, e. g.
`doc.zih.tu-dresden.de/docs/software/big_data_frameworks.md`
, use:
To check a single file, e. g.
`doc.zih.tu-dresden.de/docs/software/big_data_frameworks.md`
, use:
```
Bash
```
Bash
$DC "markdown-link-check docs/software/big_data_frameworks.md"
$DC "markdown-link-check docs/software/big_data_frameworks.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