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
11e3baa8
Commit
11e3baa8
authored
2 years ago
by
Jan Frenzel
Browse files
Options
Downloads
Plain Diff
Merge branch 'issue285' into 'preview'
Issue285 Closes
#285
See merge request
!603
parents
c6ca0a83
eb17211c
No related branches found
No related tags found
2 merge requests
!607
Automated merge from preview to main
,
!603
Issue285
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc.zih.tu-dresden.de/docs/contrib/content_rules.md
+20
-11
20 additions, 11 deletions
doc.zih.tu-dresden.de/docs/contrib/content_rules.md
with
20 additions
and
11 deletions
doc.zih.tu-dresden.de/docs/contrib/content_rules.md
+
20
−
11
View file @
11e3baa8
...
@@ -49,7 +49,7 @@ or via [Email](mailto:hpcsupport@zih.tu-dresden.de).
...
@@ -49,7 +49,7 @@ or via [Email](mailto:hpcsupport@zih.tu-dresden.de).
*
For code blocks:
*
For code blocks:
*
Use
[
syntax highlighting and appropriate prompts
](
#code-blocks-and-command-prompts
)
.
*
Use
[
syntax highlighting and appropriate prompts
](
#code-blocks-and-command-prompts
)
.
*
Respect
[
data privacy
](
#data-privacy-and-generic-names
)
.
*
Respect
[
data privacy
](
#data-privacy-and-generic-names
)
.
*
Stick to the
[
rules on optional and required arguments
](
#
unix
-rules
)
.
*
Stick to the
[
rules on optional and required arguments
](
#
code-styling
-rules
)
.
## Detailed Overview
## Detailed Overview
...
@@ -214,8 +214,8 @@ there is a list of conventions w.r.t. spelling and technical wording.
...
@@ -214,8 +214,8 @@ there is a list of conventions w.r.t. spelling and technical wording.
Providing code blocks and snippets is the meat and bones of this documentation.
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
](
#
code-styling-rules
)
Long, non-meaningful output should be omitted.
below.
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
...
@@ -345,13 +345,22 @@ Therefore, always add an example!
...
@@ -345,13 +345,22 @@ Therefore, always add an example!
If showing only a snippet of a long output, omissions are marked with
`[...]`
.
If showing only a snippet of a long output, omissions are marked with
`[...]`
.
####
Unix
Rules
####
Code Styling
Rules
Stick to the Unix rules on optional and required arguments, and selection of item sets:
*
Stick to the Unix rules on optional and required arguments, and selection of item sets:
*
`<required argument or value>`
* `<required argument or value>`
*
`[optional argument or value]`
* `[optional argument or value]`
*
`{choice1|choice2|choice3}`
* `{choice1|choice2|choice3}`
*
Please use following style guidelines while writing code blocks:
* Shell: [Shell style guide](https://google.github.io/styleguide/shellguide.html)
* Python: [PEP-0008 style guide](https://peps.python.org/pep-0008/)
* Matlab: [MATLAB programming style guide](https://www.researchgate.net/publication/316479241_Best_practices_for_scientific_computing_and_MATLAB_programming_style_guidelines)
* R: [R style guide](https://google.github.io/styleguide/Rguide.html)
* C++: [C++ style guide](https://google.github.io/styleguide/cppguide.html)
* Java: [Java style guide](https://google.github.io/styleguide/javaguide.html)
#### List of Prompts
#### List of Prompts
...
@@ -372,9 +381,9 @@ This should help to avoid errors.
...
@@ -372,9 +381,9 @@ This should help to avoid errors.
*
**Always use a prompt**
, even if there is no output provided for the shown command.
*
**Always use a prompt**
, even if there is no output provided for the shown command.
*
All code blocks which specify some general command templates, e.g. containing
`<`
and
`>`
*
All code blocks which specify some general command templates, e.g. containing
`<`
and
`>`
(see
[
placeholders
](
#placeholders
)
and
[
Unix rules
](
#unix-rules
)
), should use
`bash`
for the cod
e
(see
[
placeholders
](
#placeholders
)
and
[
Code Styling Rules
](
#code-styling-rules
)
), should us
e
block. Additionally, an example invocation, perhaps with output, should be
given with the normal
`bash`
for the code
block. Additionally, an example invocation, perhaps with output, should be
`console`
code block. See also
given with the normal
`console`
code block. See also
[
Code Block description below
](
#code-blocks-and-syntax-highlighting
)
.
[
Code Block description below
](
#code-blocks-and-syntax-highlighting
)
.
*
Using some magic, the prompt as well as the output is identified and will not be copied!
*
Using some magic, the prompt as well as the output is identified and will not be copied!
*
Stick to the
[
generic user name
](
#data-privacy-and-generic-names
)
`marie`
.
*
Stick to the
[
generic user name
](
#data-privacy-and-generic-names
)
`marie`
.
...
...
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