2019 05 27

Documentation Ideas

Existing Documentation Pieces

• https://opensource.cit-ec.de/projects/citk/repository/changes/README.md?rev=master
• https://github.com/RDTK/documentation/tree/old-documentation-dump
• https://toolkit.cit-ec.uni-bielefeld.de/tutorials/gettingstarted etc.
• "Flyer"

Structure

Introduction: Who needs this? [via https://github.com/RDTK/rdtk.github.io]

Via https://github.com/RDTK/documentation + Travis

• Tutorial
  • Tutorial: Building a distribution from scratch (including Jenkins install)
• Reference Material
  • Recipe Language
• Special Cases
  • Makefile target
  • Dockerfile target
  • Authentication/Credentials/.netrc
• Troubleshooting
• Frequently Asked Questions
  • "Meta-Job"

Workflow Issues/Ideas

• Generating Meta-Job automatically
• Better solution for .netrc