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
ab441f99
Commit
ab441f99
authored
2 years ago
by
Jan Frenzel
Browse files
Options
Downloads
Patches
Plain Diff
Changed few passive and impersonal phrases in contribution description.
parent
04e0b0f0
No related branches found
Branches containing commit
No related tags found
2 merge requests
!602
Automated merge from preview to main
,
!595
Changed few passive and impersonal phrases in contribution description.
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md
+6
-6
6 additions, 6 deletions
doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md
doc.zih.tu-dresden.de/docs/index.md
+4
-3
4 additions, 3 deletions
doc.zih.tu-dresden.de/docs/index.md
with
10 additions
and
9 deletions
doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md
+
6
−
6
View file @
ab441f99
...
...
@@ -8,8 +8,8 @@ This documentation is written in markdown and translated into static html pages
[
mkdocs
](
https://www.mkdocs.org/
)
. A single configuration file holds the pages structure
as well as specification of the theme and extensions. This file is
`mkdocs.yaml`
.
A
ll essential files (markdown pages, graphics, configuration, theme, etc.)
are managed
within a Git
repository which makes it quite easy to contribute to this documentation. In principle, there are
We manage a
ll essential files (markdown pages, graphics, configuration, theme, etc.) within a Git
repository
,
which makes it quite easy to contribute to this documentation. In principle, there are
three possible ways how to contribute to this documentation. These ways are outlined below.
## Content Guide Lines
...
...
@@ -17,16 +17,16 @@ three possible ways how to contribute to this documentation. These ways are outl
To ensure a high-quality and consistent documentation and to make it easier for readers to
understand all content, we set some
[
Content rules
](
content_rules.md
)
. Please follow
these rules regarding markdown syntax and writing style when contributing! Furthermore, reviewing
your changes take less time and your improvements appear faster on the official documentation.
your changes take
s
less time and your improvements appear faster on the official documentation.
!!! note
Each user is
fully and solely responsible for the content
he/she
create
s
and ha
s
to
ensure that
he/sh
e ha
s
the right to create it under the laws which apply.
If you contribute, you are
fully and solely responsible for the content
you
create and ha
ve
to
ensur
e
t
ha
t you have
the right to create it under the laws which apply.
## Contribute via Issue
Users
can contribute to the documentation via the
You
can contribute to the documentation via the
[
GitLab issue tracking system
](
https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/issues
)
.
For that, open an issue to report typos and missing documentation or request for more precise
wording etc. ZIH staff will get in touch with you to resolve the issue and improve the
...
...
This diff is collapsed.
Click to expand it.
doc.zih.tu-dresden.de/docs/index.md
+
4
−
3
View file @
ab441f99
...
...
@@ -8,16 +8,17 @@ information.
## Contribution
Issues concerning this documentation can reported via the GitLab
Your contributions are highly welcome. The easiest way for you to contribute is to report issues via
the GitLab
[
issue tracking system
](
https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/issues
)
.
Please check for any already existing issue before submitting your issue in order to avoid duplicate
issues.
Your contributions are highly welcome. Please find out mor
e in our
[
guidelines how to contribute
](
contrib/howto_contribute.md
)
.
Please also find out the other ways you could contribut
e in our
[
guidelines how to contribute
](
contrib/howto_contribute.md
)
.
!!! tip "Reminder"
Non-documentation issues and requests need to be send
as ticket
to
Non-documentation issues and requests need to be send to
[hpcsupport@zih.tu-dresden.de](mailto:hpcsupport@zih.tu-dresden.de).
## News
...
...
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