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
3b1ce8c9
Commit
3b1ce8c9
authored
1 year ago
by
Michael Bommhardt-Richter
Browse files
Options
Downloads
Patches
Plain Diff
Update doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md
parent
8c36f062
No related branches found
No related tags found
3 merge requests
!831
Bar
,
!828
Bin mal die ganze Seite durchgegangen...
,
!823
Bin mal die ganze Seite durchgegangen...
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md
+8
-8
8 additions, 8 deletions
doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md
with
8 additions
and
8 deletions
doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md
+
8
−
8
View file @
3b1ce8c9
...
@@ -32,23 +32,23 @@ These are described below.
...
@@ -32,23 +32,23 @@ These are described below.
## Git Workflow
## Git Workflow
We employ a so-called Git feature workflow with development branch. In our case, the working branch
We employ a so-called Git feature workflow with
a
development branch. In our case, the working branch
is called
`preview`
and is kept in parallel to the
`main`
branch.
is called
`preview`
and is kept in parallel to the
`main`
branch.
All contributions, e.g., new content, improved wording, fixed typos, etc, are added to separate
All contributions, e.g., new content, improved wording, fixed typos, etc
.
, are added to separate
feature branches which base on
`preview`
. If the contribution is ready, you will have to create a
feature branches which base on
`preview`
. If the contribution is ready, you will have to create a
merge request back to the
`preview`
branch. A member of ZIH team will review the changes (four-eyes
merge request back to the
`preview`
branch. A member of
the
ZIH team will review the changes (four-eyes
principle) and finally merge your changes to
`preview`
. All contributions need to pass the CI
principle) and finally merge your changes to
`preview`
. All contributions need to pass
through
the CI
pipeline consisting of several checks to ensure compliance with the content rules. Please, don't
pipeline consisting of several checks to ensure compliance with the content rules. Please, don't
worry too much about the checks. ZIH staff will help you with that. You
will
find more information
worry too much about the checks.
The
ZIH staff will help you with that. You
can
find more information
on
the
[
CI/CD pipeline
](
cicd-pipeline
)
in the eponymous subsection.
about
the
[
CI/CD pipeline
](
cicd-pipeline
)
in the eponymous subsection.
In order to publish the updates and make them visible in the compendium,
In order to publish the updates and make them visible in the compendium,
the changes on
`preview`
branch are either automatically merged into the
`main`
branch on every
the changes on
`preview`
branch are either automatically merged into the
`main`
branch on every
Monday via a pipeline schedule, or manually by admin staff. Moreover, the
`main`
branch is deployed
Monday via a pipeline schedule, or manually by admin staff. Moreover, the
`main`
branch is deployed
to
[
https://compendium.hpc.tu-dresden.de
](
https://compendium.hpc.tu-dresden.de
)
and always reflects
to
[
https://compendium.hpc.tu-dresden.de
](
https://compendium.hpc.tu-dresden.de
)
and always reflects
a production-ready state. Manual interventions are only necessary in case of merge conflicts.
The
a production-ready state. Manual interventions are only necessary in case of merge conflicts.
admin staff will take care on this proces
s.
This process is handled by the admin
s.
???+ note "Graphic on Git workflow"
???+ note "Graphic on Git workflow"
...
...
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