---
title: Documentation Team - nf-core Hackathon March 2023
tags: march-2023,nf-core,hackathon,progress
description: View the slide with "Slide Mode".
---

<!-- .slide: data-background="https://raw.githubusercontent.com/maxulysse/maxulysse.github.io/main/assets/img/svg/green_white_bg.svg" -->

<a href="https://www.nf-co.re"><img src="https://i.imgur.com/hEDjpCs.png" width="65%"><img></a>

### 🚀 Documentation Team 🚀

_27th-29th March 2023_

The Hackathon March 2023 [Project Board](https://github.com/orgs/nf-core/projects/38)
The Group Discussion Channel `#hackathon-march-2023-documentation`

<img src="https://openmoji.org/data/color/svg/E040.svg" width=50> @nf-core / <img src="https://openmoji.org/data/color/svg/E045.svg" width=50> @nf-core

---

# Team purpose

- Improve the documentation of all things nf-core
- for pipelines (new and existing)
- for tools
- for outreach (bytesize talks, training, translations, etc)

---

# Team Leads

Always ask first in: `#hackathon-march-2023-documentation!`

If there are issues that can't be resolved, for pointers or suggestions, contact:
* [Marcel Ribeiro-Dantas](https://github.com/mribeirodantas)
* [Louisa Perelo (Monday)](https://github.com/louperelo)
* [Franziska Bonath (Tuesday/Wednesday)](https://github.com/FranBonath)

---

# I am new, where to start?

* "_I don't know anything about GitHub!_" Click [here](https://github.com/skills/introduction-to-github) for a nice hands-on tutorial 😉.
* How to use the GitHub Project board [here](https://www.youtube.com/watch?v=gwaHz7-9v1Y&list=PL3xpfTVZLcNhfyF_QJIfSslnxRCU817yc&index=1)
* Hands-on tutorial on Markdown on GitHub [here](https://github.com/skills/communicate-using-markdown).
* Learn how to review pull requests [here](https://github.com/skills/review-pull-requests).

---

# Tasks

<small>

- **Beginner**:
- Search for and correct typos, broken links, unclear language on the website
- Try the installation guide for tools or individual pipelines, give feedback and improve
- Look for issues with "first-timer-only" tag on the project board
- **Advanced**:
- Write / improve documentation for individual pipelines
- Help with documentation for tools
- Any issues that do not have the "first-timer-only" tag

</small>

---

# Remember

* Add yourself to Team Members with your GitHub username (next slide)
* Assign yourself to issues on the [project board](https://github.com/orgs/nf-core/projects/38/views/1)
* Post your daily progress in the next slides!

---

# Team Members
@mribeirodantas, @FranBonath, @louperelo, @KarNair, @alexiandra97, @rosemariefraboulet, @vlebars, @hitowie, @vanja, @lukbut, @aelezi01, @DJevtic-Persida, @JuraNJ @laribritto @santii @atrigila @keslingmj @sujaikumar @cezargrig98 @Dante-von-Zuben @LouisLeNezet, [@daisymut](https://hackmd.io/@daisymut),@jenmuell, [@justicengom](https://github.com/justicengom), @GerardoAcquaviva, @gregorysprenger, @ameynert
[@dariader](https://github.com/dariader)
---

<small>

# Day One
## done:
- Issue [1636](https://github.com/nf-core/nf-co.re/issues/1636) on a broken link fixed by PR [1679](https://github.com/nf-core/nf-co.re/pull/1679) by Rose-Marie
- Issue [1621](https://github.com/nf-core/nf-co.re/issues/1621) on a broken link fixed by PR [1679](https://github.com/nf-core/nf-co.re/pull/1679) by Victor
- Issue [1687](https://github.com/nf-core/nf-co.re/issues/1687) fixed by PR [1691](https://github.com/nf-core/nf-co.re/pull/1691) by DJevtic
- Issue [1623](https://github.com/nf-core/nf-co.re/issues/1623) fixed by PR [1685](https://github.com/nf-core/nf-co.re/pull/1685) by DJevtic
- Issue [136](https://github.com/orgs/nf-core/projects/38/views/16?filterQuery=136&pane=issue&itemId=9929839) @aelezi01 dev branch had already restructured and fixed this doc issue
- Issue [7](https://github.com/orgs/nf-core/projects/38/views/16?filterQuery=&pane=issue&itemId=9929876) @aelezi01
- Issue [1374](https://github.com/orgs/nf-core/projects/38/views/16?filterQuery=&pane=issue&itemId=23475100)
- Local Issue [https://github.com/priyanka-surana/wgc-nextflow-hackathon-mar23/issues/24] @sujaikumar
- [#1694](https://github.com/nf-core/nf-co.re/pull/1694) by @cezargrig98
- [#1690](https://github.com/nf-core/nf-co.re/pull/1690) by @enoracrl
- [#1526](https://github.com/nf-core/nf-co.re/pull/1526) by @Dante-von-Zuben
- [#1531](https://github.com/nf-core/nf-co.re/pull/1531) by @Dante-von-Zuben
- [#1611](https://github.com/nf-core/nf-co.re/pull/1676) by @Furentsu
- Issue [#18](https://github.com/nf-core/slamseq/issues/18) "Fixing broken links for SLAMSeq documentation" by @hitowie

</small>

---

<small>

# Day One
## ready for review:
- Issue [1029](https://github.com/nf-core/nf-co.re/issues/1029) "Adding a new pipeline docs contains out of date git commands" by @KarNair
- Issue [1616](https://github.com/nf-core/nf-co.re/issues/1616) Fixed 3 image links on page https://nf-co.re/docs/contributing/design_guidelines#examples that were broken. by @JuraNJ

</small>

---

<small>

# Day One
## in progress:
- Issue [1674](https://github.com/nf-core/nf-co.re/issues/1674) @FranBonath started to add subtitles for bytesize youtube videos (14/68 done)
- Issue [229](https://github.com/nf-core/nf-co.re/issues/229) @lukbut started implementing configuration page
- PR [#1535](https://github.com/nf-core/nf-co.re/pull/1535) by @laribritto
- PR [#1528](https://github.com/nf-core/nf-co.re/pull/1528) by @atrigila
- Issue [10](https://github.com/nf-core/mnaseseq/issues/10) @vanja
- Issue [#698](https://github.com/nf-core/nf-co.re/issues/698) @gregorysprenger

</small>

---

<small>

# Day Two
## In-progress

- [1635](https://github.com/nf-core/nf-co.re/issues/1635) by @Furentsu & @GerardoAcquaviva
- Issue [224](https://github.com/nextflow-io/training/issues/224) :heart: French translation of training material by [@justicengom](https://github.com/justicengom)
- Issue :face_with_cowboy_hat:: A new tutorial for how to configure the execution of nf-core pipelines @ChrisHakk
- [3176](https://github.com/nf-core/modules/issues/3176) @FranBonath to add the bytesize transcript for nf-core/hgtseq to the website
- Issue [1053](https://github.com/nf-core/nf-co.re/issues/1053) - @lukbut modifying CPU guidance not to split cores
- Issue [891](https://github.com/nf-core/nf-co.re/issues/891) - Update modules documentation for new DSL2 syntax from the last hackathon @jenmuell
- Issue [10](https://github.com/nf-core/mnaseseq/issues/10) @vanja

In total 12 issues are labeled in progress

</small>

---

<small>

# Day Two
## Ready for review:
- Issue [1045](https://github.com/nf-core/nf-co.re/issues/1045) by @jenmuell
- Issue [1626](https://github.com/nf-core/nf-co.re/issues/1626) by @atoffano
- Issue [1029](https://github.com/nf-core/nf-co.re/issues/1029) by @KarNair
- Issue [1322](https://github.com/nf-core/nf-co.re/issues/1322) by @abhi18av / @GeOdette
- Issue [1639](https://github.com/nf-core/nf-co.re/issues/1639) by @NicRamb
- Issue [1624](https://github.com/nf-core/nf-co.re/issues/1624) by @GeradoAcquaviva
- Issue [1708](https://github.com/nf-core/nf-co.re/pull/1708) by @Furentsu
- Issue [1613](https://github.com/nf-core/nf-co.re/issues/1613) by @cezargrig98
- Issue [1528](https://github.com/nf-core/nf-co.re/pull/1528) by @atrigila / @gleisomn
- Issue [1635](https://github.com/nf-core/nf-co.re/issues/1635) by @Furentsu / @GeradoAcquaviva
- Issue [1707](https://github.com/nf-core/nf-co.re/issues/1707) by @tommasianna
- Issue [1710](https://github.com/nf-core/nf-co.re/issues/1035) by @atrigila
- PR [1523](https://github.com/nf-core/nf-co.re/pull/1523) reviewed by @hitowie
- Issue [#698](https://github.com/nf-core/nf-co.re/pull/1714) @gregorysprenger
- Issue [#1369](https://github.com/nf-core/nf-co.re/pull/1715) @gregorysprenger
- Issue [#1631](https://github.com/nf-core/nf-co.re/pull/1716) @gregorysprenger
- Issue [1455](https://github.com/nf-core/nf-co.re/issues/1455) by @atrigila

In total 10 issues are labeled as "ready for review"

</small>

---

<small>

# Day Two

## Done
- Issue [1649](https://github.com/nf-core/nf-co.re/issues/1649) More input cases and check up by @LouisLeNézet
- Issue [1700](https://github.com/nf-core/nf-co.re/issues/1700) Link in the Training - March 2023 event page points to an empty playlist @daisymut
- Issue [1698](https://github.com/nf-core/nf-co.re/issues/1698) partial meta map combine by @LouisLeNézet
- Issue [1065](https://github.com/nf-core/nf-co.re/issues/1065) advanced pattern example by @LouisLeNézet
- Issue [1674](https://github.com/nf-core/nf-co.re/issues/1674) @FranBonath added subtitles for bytesize youtube videos (35/68 done)
- Issue [1616](https://github.com/nf-core/nf-co.re/issues/1616) by @JuraNJ
- Issue [1607](https://github.com/nf-core/nf-co.re/issues/1607) closed by DJevtic
- Issue [1686](https://github.com/nf-core/nf-co.re/issues/1686) by @vlebars
- Issue [1053](https://github.com/nf-core/nf-co.re/issues/1053) by @lukbut
- Issue [1608](https://github.com/nf-core/tools/issues/1608) by @fabianegli
- Issue [1654](https://github.com/nf-core/nf-co.re/issues/1654) by @DavidEmm10

... and many more! Total of 23 Issues have flag done!

</small>

---

<small>

# Day Three

## Done

- Issue [1115](https://github.com/nf-core/nf-co.re/issues/1115) more doc on Prettier by @LouisLeNezet
- PR [891](https://github.com/nf-core/sarek/pull/981) ASCAT exome resource generation (Sarek) by @ameynert
- Issue [1455](https://github.com/nf-core/nf-co.re/issues/1455) by @atrigila

=> In total 36 issues/PRs got the label "Done"!

</small>

---

<small>

# Day Three

## In Review

- Issue [1725](https://github.com/nf-core/nf-co.re/issues/1725) Clarify to work on `dev` branch right after the creation of a new pipeline by @daisymut
- Issue [1033](https://github.com/nf-core/nf-co.re/issues/1033) Versions extraction tips by @LouisLeNezet
- Issue [1377](https://github.com/nf-core/nf-co.re/issues/1377) Delete repetition by @LouisLeNezet
- Issue [1053](https://github.com/nf-core/nf-co.re/issues/1053) by @lukbut (again!)
- Issue [1615](https://github.com/nf-core/nf-co.re/issues/1615) Update new pipeline docs by @cezargrig98
- Issue [559](https://github.com/nf-core/ampliseq/issues/559) Add description to --remove_taxa option by @dariader

=> In total 12 issues/PRs got the label "In Review"

</small>

---

<small>

# Day Three

## In Progress

=> In total 8 issues/PRs got the label "In Progress"

</small>

---

# Highlights

- New documents on how to contribute to existing pipelines
- Documentation about how to use prettier and how to install it.
- Improved documentation to pipeline schema
- Documentation/guidelines about how to do a review for modules
- Documentation about how to customise containers