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
c6e4c808
Commit
c6e4c808
authored
2 years ago
by
Taras Lazariv
Browse files
Options
Downloads
Patches
Plain Diff
Improve language
parent
7b2f3eb9
No related branches found
Branches containing commit
No related tags found
2 merge requests
!592
Automated merge from preview to main
,
!554
Content rules
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc.zih.tu-dresden.de/docs/contrib/content_rules.md
+2
-2
2 additions, 2 deletions
doc.zih.tu-dresden.de/docs/contrib/content_rules.md
with
2 additions
and
2 deletions
doc.zih.tu-dresden.de/docs/contrib/content_rules.md
+
2
−
2
View file @
c6e4c808
...
@@ -205,7 +205,7 @@ there is a list of conventions w.r.t. spelling and technical wording.
...
@@ -205,7 +205,7 @@ there is a list of conventions w.r.t. spelling and technical wording.
*
All code blocks and commands should be runnable from a login node or a node within a specific
*
All code blocks and commands should be runnable from a login node or a node within a specific
partition (e.g.,
`ml`
).
partition (e.g.,
`ml`
).
*
It should be clear from the
[
prompt
](
#list-of-prompts
)
, where the command is run (e.g., local
*
It should be clear from the
[
prompt
](
#list-of-prompts
)
, where the command is run (e.g., local
machine, login node or specific partition).
machine, login node
,
or specific partition).
#### Code Blocks and Syntax Highlighting
#### Code Blocks and Syntax Highlighting
...
@@ -213,7 +213,7 @@ Providing code blocks and snippets is the meat and bones of this documentation.
...
@@ -213,7 +213,7 @@ Providing code blocks and snippets is the meat and bones of this documentation.
Code blocks and command examples should give the general idea of invocation and be as precise as
Code blocks and command examples should give the general idea of invocation and be as precise as
possible, i.e., allowing for copy-and-paste. Please mark replaceable code parts and optional and
possible, i.e., allowing for copy-and-paste. Please mark replaceable code parts and optional and
required arguments as outlined in the section
[
required and optional arguments
](
#unix-rules
)
below.
required arguments as outlined in the section
[
required and optional arguments
](
#unix-rules
)
below.
Long, non-meaningful output should be om
m
itted.
Long, non-meaningful output should be omitted.
We make use of the extension
We make use of the extension
[
pymdownx.highlight
](
https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
)
for syntax
[
pymdownx.highlight
](
https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
)
for syntax
...
...
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