owned this note   changed 2 years ago  
Published Linked with GitHub

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More →

🚀 Documentation Team 🚀

27th-29th March 2023

The Hackathon March 2023 Project Board
The Group Discussion Channel #hackathon-march-2023-documentation

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More →
@nf-core /
Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More →
@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:

I am new, where to start?

  • "I don't know anything about GitHub!" Click here for a nice hands-on tutorial 😉.
  • How to use the GitHub Project board here
  • Hands-on tutorial on Markdown on GitHub here.
  • Learn how to review pull requests here.

Tasks

  • 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

Remember

  • Add yourself to Team Members with your GitHub username (next slide)
  • Assign yourself to issues on the project board
  • 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,@jenmuell, @justicengom, @GerardoAcquaviva, @gregorysprenger, @ameynert
@dariader

Day One

done:

Day One

ready for review:

Day One

in progress:

  • Issue 1674 @FranBonath started to add subtitles for bytesize youtube videos (14/68 done)
  • Issue 229 @lukbut started implementing configuration page
  • PR #1535 by @laribritto
  • PR #1528 by @atrigila
  • Issue 10 @vanja
  • Issue #698 @gregorysprenger

Day Two

In-progress

  • 1635 by @Furentsu & @GerardoAcquaviva
  • Issue 224
    Image Not Showing Possible Reasons
    • The image file may be corrupted
    • The server hosting the image is unavailable
    • The image path is incorrect
    • The image format is not supported
    Learn More →
    French translation of training material by @justicengom
  • Issue
    Image Not Showing Possible Reasons
    • The image file may be corrupted
    • The server hosting the image is unavailable
    • The image path is incorrect
    • The image format is not supported
    Learn More →
    : A new tutorial for how to configure the execution of nf-core pipelines @ChrisHakk
  • 3176 @FranBonath to add the bytesize transcript for nf-core/hgtseq to the website
  • Issue 1053 - @lukbut modifying CPU guidance not to split cores
  • Issue 891 - Update modules documentation for new DSL2 syntax from the last hackathon @jenmuell
  • Issue 10 @vanja

In total 12 issues are labeled in progress

Day Two

Ready for review:

  • Issue 1045 by @jenmuell
  • Issue 1626 by @atoffano
  • Issue 1029 by @KarNair
  • Issue 1322 by @abhi18av / @GeOdette
  • Issue 1639 by @NicRamb
  • Issue 1624 by @GeradoAcquaviva
  • Issue 1708 by @Furentsu
  • Issue 1613 by @cezargrig98
  • Issue 1528 by @atrigila / @gleisomn
  • Issue 1635 by @Furentsu / @GeradoAcquaviva
  • Issue 1707 by @tommasianna
  • Issue 1710 by @atrigila
  • PR 1523 reviewed by @hitowie
  • Issue #698 @gregorysprenger
  • Issue #1369 @gregorysprenger
  • Issue #1631 @gregorysprenger
  • Issue 1455 by @atrigila

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

Day Two

Done

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

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

Day Three

Done

  • Issue 1115 more doc on Prettier by @LouisLeNezet
  • PR 891 ASCAT exome resource generation (Sarek) by @ameynert
  • Issue 1455 by @atrigila

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

Day Three

In Review

  • Issue 1725 Clarify to work on dev branch right after the creation of a new pipeline by @daisymut
  • Issue 1033 Versions extraction tips by @LouisLeNezet
  • Issue 1377 Delete repetition by @LouisLeNezet
  • Issue 1053 by @lukbut (again!)
  • Issue 1615 Update new pipeline docs by @cezargrig98
  • Issue 559 Add description to –remove_taxa option by @dariader

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

Day Three

In Progress

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

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
Select a repo