ITK Documentation Hackathon, November 2023!

The Insight Toolkit (ITK) is an open-source, cross-platform toolkit for N-dimensional scientific image processing, segmentation, and registration.

The ITK Documentation Hackathon aims to bring together ITK developers and new users to expand documentation and learn to use ITK tools for scientific image processing.

We will focus on expanding and adding to new Sphinx documentation docs.itk.org by migrating content from the wiki.

Shiny new documentation portal.

Ye olde wiki.

Why Attend?

• Learn: Want to learn to use ITK, but not sure where to get started? Join the discussion and take your first steps with the ITK!
• Contribute: Have you found a great way to apply ITK in your scientific imaging work? Create an example to share your process with other community members!
• Meet: Want to interact with the ITK and scientific image processing community? Come meet the developers behind the curtain!

Mark Your Calendar

• Date: November 8th, 2023
• Time: 10am - 5pm EST
• Where: Google Meet
• Who: Anyone interested in contributing to the ITK open source community!

Prepare for the Hackathon

• Take a few seconds to register
• Visit the ITK GitHub repository
  • https://github.com/InsightSoftwareConsortium/ITK
• Create a GitHub account and fork the ITK repository
• Build the documentation locally
• Read ITK's guide to contributing

During the Hackathon

• Migrate content from the ITK Wiki to the new documentation.
• Collaborate on other ITK-related projects of your choice.
• Chat with other attendees to learn about ITK and share perspectives
• Participants are expected to adhere to ITK's Code of Conduct
• (Recommended) Have fun!

Assign yourself a task

If you would like a task to work on during the hackathon, a list is provided below.
Please add your GitHub handle next to a task when you start working on it.

• Migrate ITK Wiki pages to docs.itk.org - instructions
  • Getting Started -
  • About - translate more up-to-date page itk.org/about to markdown -
  • FAQ - jhlegarreta
  • License, integrate with NOTICE, change NOTICE to markdown - thewtex - PR
  • Add CDash link - thewtex - PR
  • Mark Version control and releases wiki pages with {{ Historical }} -
  • Configuring and building -
  • Compilers, integrate with updated version - thewtex - PR
  • Branches -
  • Doxygen Documentation -
  • ITKDoxygen on GitHub
  • Dashboard Setup
  • Developer statistics (new system?)
  • Plugin IO mechanisms -
  • Open Science -
  • Other Software -
  • MetaIO -
• Work on example issues
  • #308
  • […] -
• Work on ITK Documentation issues
  • #4291
  • #4300
  • […]
• Migrate the ITKPythonPackage docs - tbirdso
• Migrate the remote module GitHub Action docs - tbirdso
• Migrate the ITK v5 Migration Guide - thewtex - PR

Acknowledgements

This hackathon is supported by the Insight Software Consortium (ISC) via NumFOCUS. ITK is a fiscally sponsored project of NumFOCUS, a non-profit dedicated to supporting the open source scientific computing community. If you want to support ISC's mission to promote and maintain open-source, freely available software for medical image analysis in teaching, research, and commercial applications, please consider making a donation to support our efforts.