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
37b64927
Commit
37b64927
authored
3 years ago
by
Martin Schroschk
Browse files
Options
Downloads
Patches
Plain Diff
Fix headers
parent
88c05d46
No related branches found
Branches containing commit
No related tags found
2 merge requests
!322
Merge preview into main
,
!319
Merge preview into main
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc.zih.tu-dresden.de/util/README.md
+24
-9
24 additions, 9 deletions
doc.zih.tu-dresden.de/util/README.md
with
24 additions
and
9 deletions
doc.zih.tu-dresden.de/util/README.md
+
24
−
9
View file @
37b64927
...
@@ -10,12 +10,13 @@ request.
...
@@ -10,12 +10,13 @@ request.
*
Check code and command examples
*
Check code and command examples
*
Check no floating pages and depth of page tree
*
Check no floating pages and depth of page tree
##
#
Markdown Linter
## Markdown Linter
The
[
markdown linter client
](
https://github.com/igorshubovych/markdownlint-cli
)
helps to keep the
The
[
markdown linter client
](
https://github.com/igorshubovych/markdownlint-cli
)
helps to keep the
markdown source code clean and consistent.
markdown source code clean and consistent.
Installation
Installation
```
Shell Session
```
Shell Session
~ npm install markdownlint-cli
~ npm install markdownlint-cli
```
```
...
@@ -43,13 +44,14 @@ README.md:22 MD022/blanks-around-headings/blanks-around-headers Headings should
...
@@ -43,13 +44,14 @@ README.md:22 MD022/blanks-around-headings/blanks-around-headers Headings should
[8< 8<]
[8< 8<]
```
```
##
#
Check Links
## Check Links
No one likes dead links. Therefore, we check the internal and external links within the markdown
No one likes dead links. Therefore, we check the internal and external links within the markdown
source files. For that, the script
`util/check-links.sh`
and/or the tool
source files. For that, the script
`util/check-links.sh`
and/or the tool
[
markdown-link-check
](
https://github.com/tcort/markdown-link-check
)
can be used.
[
markdown-link-check
](
https://github.com/tcort/markdown-link-check
)
can be used.
Installation
Installation
```
Shell Session
```
Shell Session
~ npm install markdown-link-check
~ npm install markdown-link-check
```
```
...
@@ -74,28 +76,41 @@ ERROR: 2 dead links found!
...
@@ -74,28 +76,41 @@ ERROR: 2 dead links found!
[✖] CONTRIBUTE.md → Status: 400
[✖] CONTRIBUTE.md → Status: 400
```
```
**TODO:**
When and how to run
`util/check-links.sh`
?
### Usage
Check links within changed git-versioned markdown files, invoke
```
Shell Session
~ sh doc.zih.tu-dresden.de/util/check-links.sh
```
from top-level directory.
To check all markdown files for broken links, invoke
```
Shell Session
~ find . -name \*.md -exec markdown-link-check -q {} \;
```
##
#
Check Code and Commands
## Check Code and Commands
1.
All code blocks and commands should be runnable from a login node.
All code blocks and commands should be runnable from a login node.
1.
**TODO:**
Implement
[
Issue #9
](
#9
)
**TODO:**
Implement
[
Issue #9
](
#9
)
##
#
Check Pages Structure
## Check Pages Structure
The script
`check-no-floating.sh`
contains two checks. It first checks the hierarchy depth of the
The script
`check-no-floating.sh`
contains two checks. It first checks the hierarchy depth of the
pages structure. By design, no page in the documentation should be lower than four levels w.r.t. top
pages structure. By design, no page in the documentation should be lower than four levels w.r.t. top
level, i.e., landing page. Secondly, the script tests if every markdown file is included in the
level, i.e., landing page. Secondly, the script tests if every markdown file is included in the
navigation section within the
`mkdocs.yaml`
file of this project.
navigation section within the
`mkdocs.yaml`
file of this project.
###
#
Usage
### Usage
```
bash
```
bash
sh doc.zih.tu-dresden.de/utils/check-no-floating.sh doc.zih.tu-dresden.de
sh doc.zih.tu-dresden.de/utils/check-no-floating.sh doc.zih.tu-dresden.de
```
```
###
#
Return codes
### Return codes
*
-1/255 if any error occurs, 0 otherwise
*
-1/255 if any error occurs, 0 otherwise
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