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
87669739
Commit
87669739
authored
3 years ago
by
Martin Schroschk
Browse files
Options
Downloads
Patches
Plain Diff
Add document wrt hackathon
parent
1b5b8579
No related branches found
No related tags found
3 merge requests
!322
Merge preview into main
,
!319
Merge preview into main
,
!5
Issue#6
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc.zih.tu-dresden.de/hackathon.md
+39
-0
39 additions, 0 deletions
doc.zih.tu-dresden.de/hackathon.md
with
39 additions
and
0 deletions
doc.zih.tu-dresden.de/hackathon.md
0 → 100644
+
39
−
0
View file @
87669739
# Hackathon June 2021
The goals for the hackathon are:
*
Familiarize main editors (ZIH admin group and domain experts) with new workflow and system
*
Bringing new compendium to life by
*
Reviewing content of old compendium
*
Transferring reviewed content into new structure and system
## twiki2md
The script
`twiki2md`
converts twiki source files into markdown source files using pandoc. It outputs the
markdown source files according to (old) pages tree. The output can be found at branch
`preview`
within directory
`compendium/`
.
## Steps
### Familiarize with New Wiki System
### Transferring Content
1.
Grab a markdown source file from
`compendium`
directory (a topic you are comfortable with)
1.
Review the markdown source file
*
Replace or remove (leftover) html constructs in markdown source file
*
Add ticks for code blocks and command if necessary
*
Fix internal links (mark as todo if necessary)
*
Review and update, remove outdated content
1.
Find place in new structure according to
[
Typical Project Schedule
](
https://doc.zih.tu-dresden.de/hpc-wiki/bin/view/Compendium/TypicalProjectSchedule
)
*
Copy reviewed markdown source file to
`doc.zih.tu-dresden.de/docs/SUBDIR/<FILENAME>.md`
*
Update navigation section in
`mkdocs.yaml`
1.
Apply git workflow
*
Add
`<FILENAME>.md`
to git repository
*
Commit all changed file, e.g.,
`<FILENAME.md>`
,
`mkdocs.yaml`
and graphics from this documentation
page
*
Push changes to new branch
*
``
git push origin
*
Create
[
merge request
](
https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/merge_requests
)
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