Oa8choo2 mdfix #1103
Oa8choo2 mdfix #1103
Conversation
$ rumdl check getting_started.md ... Issues: Found 91 issues in 1 file (69ms) Run `rumdl fmt` to automatically fix 45 of the 91 issues $ rumdl check --fix getting_started.md Fixed: Fixed 45/91 issues in 1 file (116ms) $ rumdl check getting_started.md ... Issues: Found 61 issues in 1 file (69ms) Run `rumdl fmt` to automatically fix 16 of the 61 issues $ rumdl check --fix getting_started.md Fixed: Fixed 16/61 issues in 1 file (103ms) $ rumdl check getting_started.md Issues: Found 45 issues in 1 file (68ms) $ rumdl check getting_started.md | grep 'Line length' -c 45 => rumdl can not fix the line length errors automatically
and some spelling
and some minor rewording
|
We should probably set up CI for this too, so we don't introduce failures again when further editing pages that have been cleaned up? See https://github.com/rvben/rumdl?tab=readme-ov-file#github-actions |
| @@ -1,111 +1,153 @@ | |||
| # Title | |||
There was a problem hiding this comment.
This doesn't make much sense, it'll just add a title named Title to the top of the page?
Maybe you should just move down the {% set ...} below the existing title # Getting Started`?
I'm not sure that'll work those, these set statement may have to be on top...
If so, is there a way to tell rumdl to ignore particular lines or checks?
In this case, there may be a good reason not to have the title at the very top of the file...
There was a problem hiding this comment.
rumdl supports inline HTML comments to disable or configure rules for specific sections of your Markdown files. This is useful for making exceptions without changing global configuration:
https://github.com/rvben/rumdl#:~:text=%3C!--%20rumdl-disable%20MD013%20--%3E
| To get access to the {{hpcinfra}}, you need [an HPC account](account.md). | ||
|
|
||
| If you have not used Linux before, | ||
| If you have not used Linux before, |
There was a problem hiding this comment.
adding trailing whitespace is a good thing according to rumdl ? 🤔
There was a problem hiding this comment.
two spaces indicate a line break in markdown
| 1. Connect to the login nodes | ||
| 2. Transfer your files to the {{hpcinfra}} | ||
| 3. Optional: compile your code and test it |
There was a problem hiding this comment.
more nitpicking: avoid introducing trailing whitespace?
| - [Using the web portal](web_portal.md) | ||
|
|
||
| Considering your operating system is **{{OS}}**, | ||
| Considering your operating system is **{{OS}}**, |
There was a problem hiding this comment.
more nitpicking: avoid introducing trailing whitespace?
| Assuming you have already generated SSH keys in the previous step ([Getting | ||
| Access](#getting-access)), and that they are in a default location, you should | ||
| now be able to login by running the following command: |
There was a problem hiding this comment.
| Assuming you have already generated SSH keys in the previous step ([Getting | |
| Access](#getting-access)), and that they are in a default location, you should | |
| now be able to login by running the following command: | |
| Assuming you have already generated SSH keys in the previous step | |
| (see [Getting Access](#getting-access)), and that they are in a default location, | |
| you should now be able to login by running the following command: |
| Replace **{{userid}}** with your VSC account id (see <https://account.vscentrum.be>) | ||
| !!! Warning "Use your own VSC account id" | ||
|
|
||
| ```text |
There was a problem hiding this comment.
Hmm, this probably doesn't make it go under the "warning" box anymore?
Did you check the rendered page?
|
|
||
| You can also still use the web portal (see [shell access on web portal](web_portal.md#shell-access)) | ||
| ```text | ||
| You can also still use the web portal (see [shell access on web |
There was a problem hiding this comment.
Same here, this must be indented to go into the tip box
| Download following the example scripts to your computer: | ||
|
|
||
| - [tensorflow_mnist.py](https://raw.githubusercontent.com/hpcugent/vsc_user_docs/main/{{exampleloc}}/tensorflow_mnist.py) | ||
| - [tensorflow_mnist.py](https://raw.githubusercontent.com/hpcugent/vsc_user_docs/main/{{exampleloc}}/tensorflow_mnist.py) |
There was a problem hiding this comment.
more nitpicking: avoid introducing trailing whitespace?
| Upload both files (`run.sh` and `tensorflow-mnist.py`) to your **home | ||
| directory** and go back to your shell. |
There was a problem hiding this comment.
some line break are a bit random, better:
| Upload both files (`run.sh` and `tensorflow-mnist.py`) to your **home | |
| directory** and go back to your shell. | |
| Upload both files (`run.sh` and `tensorflow-mnist.py`) to your | |
| **home directory** and go back to your shell. |
|
|
||
| As an alternative, you can use WinSCP (see [our section](connecting.md#winscp)) | ||
| ```text | ||
| As an alternative, you can use WinSCP (see [our section](connecting.md#winscp)) |
There was a problem hiding this comment.
must be indented to go into info box?
| Replace **{{userid}}** with your VSC account id (see <https://account.vscentrum.be>) | ||
|
|
||
| ```text | ||
| Replace **{{userid}}** with your VSC account id (see <https://account.vscentrum.be>) |
There was a problem hiding this comment.
must be indented to go into warning box?
|
|
||
| For more information about transfering files or `scp`, see [tranfer files from/to hpc](connecting.md#transfer-files-tofrom-the-hpc). | ||
| ```text | ||
| For more information about transferring files or `scp`, see [transfer files |
There was a problem hiding this comment.
must be indented to go into info box?
| A job script is a shell script, a text file that specifies the resources, | ||
| the software that is used (via `module load` statements), |
There was a problem hiding this comment.
avoid introducing trailing whitespace
| When submitting jobs with limited amount of resources, it is recommended to use the [debug/interactive cluster](interactive_debug.md#interactive-and-debug-cluster): `donphan`. | ||
|
|
||
| ```text | ||
| When submitting jobs with limited amount of resources, it is recommended to use |
There was a problem hiding this comment.
must be indented to go into tip box?
| To get a list of all clusters and their hardware, see <https://www.ugent.be/hpc/en/infrastructure>. | ||
| ```text | ||
| To get a list of all clusters and their hardware, see | ||
| <https://www.ugent.be/hpc/en/infrastructure>. |
There was a problem hiding this comment.
This won't result in a clickable link anymore?
| ```text | ||
| Note that the module commands only modify environment variables. For instance, | ||
| running `module swap cluster/{{othercluster}}` will update your shell | ||
| environment so that `qsub` submits a job to the `{{othercluster}}` cluster, | ||
| but our active shell session is still running on the login node. | ||
| ``` | ||
|
|
||
| ```text | ||
| It is important to understand that while `module` commands affect your session | ||
| environment, they do ***not*** change where the commands your are running are | ||
| being executed: they will still be run on the login node you are on. | ||
| ``` | ||
|
|
||
| ```text | ||
| When you submit a job script however, the commands ***in*** the job script will | ||
| be run on a workernode of the cluster the job was submitted to (like | ||
| `{{othercluster}}`). | ||
| ``` |
There was a problem hiding this comment.
must be indented to go into warning box?
|
|
||
| For more information about the stdout and stderr output channels, see this [section](linux-tutorial/beyond_the_basics.md#inputoutput). | ||
| ```text | ||
| For more information about the stdout and stderr output channels, see this |
There was a problem hiding this comment.
must be indented to go into info box?
|
|
||
| When examining the contents of ``run.sh.o{{jobid}}`` you will see something like this: | ||
| ```text | ||
| Replace **{{jobid}}** with the jobid you got from the `qstat` command (see |
There was a problem hiding this comment.
must be indented to go into warning box?
| ```text | ||
| When using TensorFlow specifically, you should actually submit jobs to a GPU | ||
| cluster for better performance, see [GPU clusters](gpu.md). | ||
| ``` | ||
|
|
||
| For the purpose of this example, we are running a very small TensorFlow workload on a CPU-only cluster. | ||
| ```text | ||
| For the purpose of this example, we are running a very small TensorFlow | ||
| workload on a CPU-only cluster. |
There was a problem hiding this comment.
must be indented to go into warning box?
|
Ok, I'll review these. Thank you for your review. |
Oa8choo2
added
wip
Co-authored-by: Kenneth Hoste <kenneth.hoste@ugent.be>
This makes changes in
mkdocs/docs/HPC/getting_started.md
to make the Markdown code more compliant with the markdown linter rumdl
https://github.com/rvben/rumdl
It is my intention to process the other markdown files in the same way.