Documentation updates for v0.4.1 - Githubissues

bihealth / sodar-core

SODAR Core: A Django-based framework for building scientific data management web apps

MIT License

9 stars 1 forks source link

Documentation updates for v0.4.1 #50

Closed mikkonie closed 2 years ago

mikkonie commented 6 years ago

Collecting things to add/fix in the documentation here, feel free to contribute.

[x] Rework Projectroles integration doc for sodar_django_site
[x] Add guide for implementing tour help
[x] Add note on app vs plugin naming (must be identical for certain UI stuff to work, e.g. sidebar highlight)
[x] Fix owner role description ("sub-projects under projects" is wrong)
[x] Add a more detailed guide for SODAR compatible templates (based on comments currently being written for varfish)
[x] Ensure timeline backend is properly mentioned (noted by Manuel)
[x] API docs for relevant modules (see vcfpy for example)
[x] ~~Add instructions on how to build API views with permission checking etc.~~ Adding a short description for now, proper doc to be done once we unify a general SODAR API
[x] Remove redundant timeline app basics doc, merge content with the main timeline doc
[x] Guide for site app messages
[x] Document #111 once done (remember to add breaking changes note)
[x] Update author info
[x] Point links to Github

mikkonie commented 6 years ago

mentioned in commit 8e6a972ad4a9bcf6f9a7df7148fe82a862c4fd78

mikkonie commented 6 years ago

marked the task Rework Projectroles integration doc for sodar_django_site as completed

mikkonie commented 6 years ago

marked the task Fix owner role description ("sub-projects under projects" is wrong) as completed

mikkonie commented 6 years ago

mentioned in commit e28afaa8e4268a75afbe3d2c3e249ec4c29ac81f

mikkonie commented 6 years ago

mentioned in commit 1d9ec97d2e3a61cc265f033162c961f8dcb9d7b1

mikkonie commented 6 years ago

marked the task Ensure timeline backend is properly mentioned (noted by Manuel) as completed

mikkonie commented 5 years ago

marked the task Remove redundant timeline app basics doc, merge content with the main timeline doc as completed

mikkonie commented 5 years ago

mentioned in commit 9652d2093a51b710dd317f10f26ffdee4e09a8da

mikkonie commented 5 years ago

mentioned in commit 87c100f0ac13840be44366b334243164faee6825

mikkonie commented 5 years ago

marked the task Add guide for implementing tour help as completed

mikkonie commented 5 years ago

marked the task Add note on app vs plugin naming (must be identical for certain UI stuff to work, e.g. sidebar highlight) as completed

mikkonie commented 5 years ago

mentioned in commit 7bb28f96600b7d28d1165d3ea1a5511197b8b71e

mikkonie commented 5 years ago

mentioned in commit 186ab2bc9be2bd3758380e789becf01abaa50c1a

mikkonie commented 5 years ago

marked the task Add a more detailed guide for SODAR compatible templates (based on comments currently being written for varfish) as completed

mikkonie commented 5 years ago

mentioned in commit 1c699baceb02dd2a1edb41edc834e2dc08a79fb0

mikkonie commented 5 years ago

marked the task ~~Add instructions on how to build API views with permission checking etc.~~ Adding a short description for now, proper doc to be done once we unify a general SODAR API as completed

mikkonie commented 5 years ago

mentioned in commit 6bad6a52bee32e09262df19643ea11a53cb4d353

mikkonie commented 5 years ago

marked the task Document #111 once done (remember to add breaking changes note) as completed

mikkonie commented 5 years ago

mentioned in commit 7f61aa665336152cadaa3aee4bf30470ebadec69

mikkonie commented 5 years ago

marked the task Guide for site app messages as completed

mikkonie commented 5 years ago

mentioned in commit 7a46999456b3dae20ee65d77015e3d7386b79777

mikkonie commented 5 years ago

mentioned in commit 4797cdacacea52cfead00b516421f62a22aa6a36

mikkonie commented 5 years ago

mentioned in commit 5970e466f8137d1fb0b5c9539663a23b4a6534b5

mikkonie commented 5 years ago

mentioned in commit a445da1c1739ef7bf657af3040761199443daea4

mikkonie commented 5 years ago

mentioned in commit bce9480a1a502b5cf7434c9dac326edc004cb170

mikkonie commented 5 years ago

mentioned in commit 73c6aedfa84269618c99dced9be87be8081a29a1

mikkonie commented 5 years ago

mentioned in commit 76f43e465c18030aa97d5681b668685d27826dd5

mikkonie commented 5 years ago

marked the task API docs for relevant modules (see vcfpy for example) as completed

mikkonie commented 5 years ago

mentioned in commit a3d6c01610e525bca385c1cb33a0df9e07992fbc

mikkonie commented 5 years ago

marked the task Update author info as completed

mikkonie commented 5 years ago

marked the task Point links to Github as completed

mikkonie commented 5 years ago

Done.

mikkonie commented 5 years ago

closed