<!-- .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> # 🚀 nf-core/tools Documentation 🚀 _16th-18th March 2022_ <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 --- # nf-core/tools Team --- # Team Members * Matthias H * Phil * Pauline * Rike * Edmund * Matthias Z --- # Reorganize Docs ![](https://media2.giphy.com/media/j6wvxJLueHV10lATCF/giphy.gif?cid=ecf05e47cpcsehu6kbqih4nevah6ssjcmkd3f3cke2idx1sq&rid=giphy.gif&ct=g) --- # Website navigation - Developer -> Contributing - Day 2: working on sidebar nav - Day 3: We have a sidebar (needs more styling ✨) ![](https://i.imgur.com/PPzVsTm.png) --- # Reorganise Tools Docs - Split readme into individual files --- # Tools Sphinx docs - Autogenerates docs about lint tests, API - Versioned and created, but not really linked --- # Tools Sphinx docs - **DONE**: Review / merge: Convert Sphinx prose RST to Markdown _(not the docstrings :sob:)_ ([#1245](https://github.com/nf-core/tools/pull/1245)) - **DONE**: Review / merge: Add docs for _module_ lint tests ([#1250](https://github.com/nf-core/tools/pull/1250)) --- # Tools Sphinx docs - ~~_TODO_: Rewrite with MkDocStrings to have full markdown support??~~ - _TODO_: Integrate styling with website --- # Module lint test docs <iframe width="100%" height="500" src="https://nf-co.re/tools/docs/dev/module_lint_tests/meta_yml.html" frameborder="0"></iframe> --- # Code linting with [Prettier](https://prettier.io) Previously: `markdownlint` and `yamllint` Problems with the last tools release. Been annoying for a while --- ![](https://i.makeagif.com/media/3-16-2016/3vkUVo.gif) --- ![](https://c.tenor.com/Kl1RWj007bEAAAAd/danny-devito-walking-away.gif) --- # Markdownlint and Yamllint now gone - **MERGED** nf-core/tools (@ewels) - **MERGED** Pipeline template (@ewels) - **READY** Website (@Emiller88) - **MERGED** nf-core/modules (@Emiller88) - nf-core/configs (@Emiller88) --- # Prettier now everywhere - Applied to pipeline and website code - CI checks to make sure code validates - _Soon_: A bot to respond to PR comments and commit Prettier fixes automatically??? --- # Tools release today!??! ![](https://i.makeagif.com/media/8-14-2017/ZtZuZT.gif) --- # nf-core/testpipeline * Syncing nf-core/testpipeline with latest tool changes on dev to test Prettier * Prettier & editorsconfig don't play nice --- # GitPod docker images * Tried to fix the docker image build, failed :laughing: ---
{"metaMigratedAt":"2023-06-16T20:21:45.950Z","metaMigratedFrom":"YAML","title":"nf-core/tools Documentation - nf-core Hackathon March 2022","breaks":true,"description":"View the slide with \"Slide Mode\".","contributors":"[{\"id\":\"41476d21-4b95-4fee-8577-7df5bb3e16ba\",\"add\":1690,\"del\":36},{\"id\":\"4c34251a-2801-4765-8472-fa5c6c285389\",\"add\":444,\"del\":44},{\"id\":\"2aeca590-9d00-4b4f-a58a-620945456c9f\",\"add\":850,\"del\":0}]"}
    1582 views
   Owned this note