Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
Example Portfolio Application Example Portfolio Application
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3
    • Issues 3
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Wiki
    • Wiki
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • E-10
    • Teaching
  • Mathematical Image Processing
  • Example Portfolio ApplicationExample Portfolio Application
  • Issues
  • #11

Closed
Open
Created Sep 27, 2021 by Fabian Nuraddin Alexander Gabel@cfg0846Owner8 of 9 tasks completed8/9 tasks

Documentation

Comments and README

  • Rewrite README.md
  • Comment the routines
  • Comment the .gitlab-ci.yml files
  • Comment the TeX template if necessary
  • Add "LABEL"s to the Dockerfile (Author/Maintainer, Usage, Version etc. whatever seems suitable)
  • Add Screenshots of the demo.pdf (maybe even upload a demo.pdf) to the wiki
  • Document unit tests

The amount of comments should be reasonable.

User Documentation, Installation, Use cases

  • Document the use cases in the project wiki
  • Describe the "Installation" of the project in the project wiki, i.e. what do I need to do in order to set it up properly in my own project). You can use Screenshots, gifs (with peek) or a screencast. Maybe resolve https://collaborating.tuhh.de/cqp7011/mathbildprojektjj/-/issues/13 first
Edited Feb 10, 2022 by Fabian Nuraddin Alexander Gabel
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking