# Hackathon Oct-2022 (Documentation Group) - Organization ## 2022-08-29 present: Marcel, Fran, Abhinav (later with Marcel) ## General - Take advantage of the [Project Board in March's 2022 Hackathon](https://github.com/orgs/nf-core/projects/27/views/4). There are a lot of undone (?) tasks there. - The groups defined there are already nice and we should copy this also. - This file: [https://hackmd.io/@nf-core/SJOCc4cJi/edit](https://hackmd.io/@nf-core/SJOCc4cJi/edit) - The Hackathon Oct 2022 [Project Board](https://github.com/orgs/nf-core/projects/38/views/1) **UPDATE**: Phil mentioned this time the Hackathon won't be restricted to documentation, as it was in March, so documentation, for example, will be a tab (instead of a whole board). It's still fine, I think. What do you think, **Franziska**? ### TODO - [x] familiarize ourselves with Github projects **UPDATE:** Abhinav gave Marcel a nice tour on it - [ ] ~~Find a way to either clone the board, or export[[1](https://github.com/orgs/community/discussions/21981)][[2](https://github.com/wustep/github-project-exporter)]/import the data into a new one. Assigned to @mribeirodantas **UPDATE**: Marcel and Abhinav created [a new project](https://github.com/orgs/nf-core/projects/38) in the nf-core organization on GitHub and we can link the ongoing issues from nf-core repositories there relatively easy, as shown by Abhinav. Marcel and Abhinav will work on this to collect ongoing issues + add new ones from the other board.~~ - [x] [Hackathon board](https://github.com/orgs/nf-core/projects/38/). We can just "get" the issues from nf-core repositories. Assigned to **Abhinav**. - [x] Check if everyone can add things to the board, edit and so on, or only us with orgs powers Answer: https://github.com/orgs/nf-core/projects/27/settings/access - [ ] figure out what to say in intros and check-in. Assigned to **Fran** **UPDATE**: Marcel and Abhinav discussed about that, and it would be great to have some 5-10min presentation on how to use GitHub UI to contribute to the documentations. See task below. - [ ] Prepare 5-10min short intro to PR/commit/review with the GitHub UI (docs will be usually one file per time being updated, so the GitHub UI is fine). - [ ] What to suggest for people who don't know much about nf-core/nextflow/bioinformatics? Ideas: Fix typos, get them in touch with pipeline authors for questions (GENERIC docs tasks) ## VIDEOS!!! - New/updated bytesize talk with a whole new presentation for established pipelines, as if it was new. - It doesn’t have to be a bytesize, but if it hasn’t occurred before, that would be a good idea. - walk-through for running a specific pipeline **UPDATE**: Phil thinks finding new videos is higher in priority when compared to finding outdated videos to update/record. And a nice idea would be to add some box-like thing in the YouTube videos to alert people that the content may be outdated. ### TODO - [x] contact potential speakers (Fran) - schedule times (either during the hackathon or outside) - [x] figure out if it will be part of bytesize talks or not - [ ] Create a *Creative Guide* for people who will record their videos. Assigned to @mribeirodantas ## 2022-09-06 present: Marcel, Fran, Abhinav ## General - If by any chance someone really wants to record a video, Marcel will walk with them to Seqera's HQ where they can use the booth for recording. - Sessions:1 => Introduce people to Github projects (Docs at least) - Explore tools / modules / website - TODO @Fran: Improve the searchability of bytesize talks / vidoes - perhaps nf-core/talks section the website. Can also be done via playlists on YouTube. Elaborate the draft issue on Hackathon board. - TODO @abhinav: Design a draft of sessions to be covered in hackathon ## Video updates - https://trello.com/c/tm85nerx - (Consider explaining/covering the AWS reports in later videoes - multiple videoes about the pipeline) - [x] @abhi18av: Add more doc issues to board and categories these issues - A later video about running the pipeline on different platforms - TODO @marcel Recording tools and guidelines - OBS (offline) - Zoom (online) - Others? - TODO @Fran Talk structure - Suggest running conda,docker/podman/singluarity - locally - Main nf-core website page (especially quickstart) https://nf-co.re/rnaseq/3.8.1 - Run the pipeline on the terminal - Elaborate on contents of samplesheet - Elaborate on pipeline parameters (on test data) => Request authors to setup the test data locally, update samplesheet - DONE - TODO @fran: Schedule times (either during the hackathon or outside) [INTERNAL] - TODO @abhinav: Design participant-personas: For example, an interested nf-core pipeline user can proof-read the various pipelines usage docs. ## 2022-09-16 present: Marcel, Abhinav TODO - [ ] Build a schedule for the days ASAP --------------------------------- # Final Hackathon Prep (Documentation group) -
{"metaMigratedAt":"2023-06-17T07:52:21.473Z","metaMigratedFrom":"YAML","title":"Documentation Team Organization - nf-core Hackathon October 2022","breaks":true,"description":"View the slide with \"Slide Mode\".","contributors":"[{\"id\":\"fb193497-1111-470c-a594-827d34b6f673\",\"add\":246,\"del\":22},{\"id\":\"6357fb8d-b0f8-4b7d-9fbe-6d813ad67700\",\"add\":161,\"del\":0},{\"id\":\"215430ec-a8bf-467e-bd64-43412a72b076\",\"add\":1719,\"del\":135},{\"id\":\"ebc6686b-7394-48da-9081-2dccb25355cb\",\"add\":3123,\"del\":397},{\"id\":\"ee32e9e7-6d77-4da7-89d5-6a7b67d3a95b\",\"add\":545,\"del\":65}]"}
    295 views
   Owned this note