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
29bd2af4
Commit
29bd2af4
authored
3 years ago
by
Martin Schroschk
Browse files
Options
Downloads
Patches
Plain Diff
Add guidelines
parent
31abd0f7
No related branches found
No related tags found
3 merge requests
!392
Merge preview into contrib guide for browser users
,
!387
Merge preview into main
,
!384
Improve documentation on how to create issue
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc.zih.tu-dresden.de/docs/contrib/content_rules.md
+10
-0
10 additions, 0 deletions
doc.zih.tu-dresden.de/docs/contrib/content_rules.md
with
10 additions
and
0 deletions
doc.zih.tu-dresden.de/docs/contrib/content_rules.md
+
10
−
0
View file @
29bd2af4
...
@@ -51,6 +51,10 @@ should be highlighted, etc. Code examples, longer than half screen height should
...
@@ -51,6 +51,10 @@ should be highlighted, etc. Code examples, longer than half screen height should
## Writing Style
## Writing Style
*
Capitalize headings, e.g.
*Exclusive Reservation of Hardware*
*
Capitalize headings, e.g.
*Exclusive Reservation of Hardware*
*
Use active over passive voice
*
Write with confidence. This confidence should be reflected in the documentation, so that
the readers trust and follow it.
*
Example:
`We recommend something`
instead of
`Something is recommended.`
## Spelling and Technical Wording
## Spelling and Technical Wording
...
@@ -64,6 +68,12 @@ there is a list of conventions w.r.t. spelling and technical wording.
...
@@ -64,6 +68,12 @@ there is a list of conventions w.r.t. spelling and technical wording.
*
`ZIH system`
and
`ZIH systems`
not
`Taurus`
etc. if possible
*
`ZIH system`
and
`ZIH systems`
not
`Taurus`
etc. if possible
*
`Workspace`
not
`work space`
*
`Workspace`
not
`work space`
### Long Options
*
Use long over short options, e.g.
`srun --nodes=2 --ntasks-per-node=4 ...`
is prefered over
`srun -N 2 -n 4 ...`
*
Use
`module`
over the short front-end
`ml`
in documentation and examples
## Code Blocks and Command Prompts
## Code Blocks and Command Prompts
Showing commands and sample output is an important part of all technical documentation. To make
Showing commands and sample output is an important part of all technical documentation. To make
...
...
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