Skip to content
Snippets Groups Projects
Commit 9b336444 authored by Ulf Markwardt's avatar Ulf Markwardt
Browse files

Update contribute_container.md

parent 170ae8bb
No related branches found
No related tags found
3 merge requests!322Merge preview into main,!319Merge preview into main,!300Contrib container
...@@ -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"
``` ```
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment