Bug 48527 - Add workflow description for installation of an app
Add workflow description for installation of an app
Status: CLOSED FIXED
Product: UCS extended documentation
Classification: Unclassified
Component: App Provider
unspecified
Other Linux
: P5 normal (vote)
: ---
Assigned To: Nico Gulden
Dirk Wiesenthal
:
: 48736 (view as bug list)
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2019-01-24 14:34 CET by Nico Gulden
Modified: 2019-04-29 22:07 CEST (History)
2 users (show)

See Also:
What kind of report is it?: Bug Report
What type of bug is this?: 2: Improvement: Would be a product improvement
Who will be affected by this bug?: 2: Will only affect a few installed domains
How will those affected feel about the bug?: 2: A Pain – users won’t like this once they notice it
User Pain: 0.046
Enterprise Customer affected?:
School Customer affected?:
ISV affected?: Yes
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional):
Max CVSS v3 score:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Nico Gulden univentionstaff 2019-01-24 14:34:01 CET
The app provider documentation should include a description of the installation workflow for an app. What happens from the install command until a successful installation? What script hooks are available and what information is available from UCS that can be used at those stages.

A first description can be found in this old and deleted wiki article: https://wiki.univention.de/index.php?title=Docker_Apps/Image_Based&oldid=13408
Comment 1 Nico Gulden univentionstaff 2019-03-20 11:40:20 CET
*** Bug 48736 has been marked as a duplicate of this bug. ***
Comment 2 Nico Gulden univentionstaff 2019-03-20 17:06:34 CET
The graphics are moved to the documentation and updated to make them more readable. They have been added to the App configuration chapter. I also added some more sections on scripts missing documentation in the respective workflow sections.

The complete diff is here:
https://git.knut.univention.de/univention/ucs/compare/4.4-0...ngulden%2F48527-app-docu-workflow-description

For QA, please use Jenkins at http://jenkins.knut.univention.de:8080/job/BuildDocBookBranch/ and build branch `ngulden/48527-app-docu-workflow-description`.
Comment 3 Dirk Wiesenthal univentionstaff 2019-04-26 14:37:09 CEST
Please make minor adjustnments in app-provider-4.4.xml:
Remove
  "It is also called a preinst script" (~l 2000)

Typo in section Upgrade / Configure

The parameters are the app action "ugprade"

Otherwise, sounds great.

Please merge.
Comment 4 Nico Gulden univentionstaff 2019-04-26 14:58:28 CEST
Merged.
Comment 5 Nico Gulden univentionstaff 2019-04-26 14:58:37 CEST
Verified
Comment 6 Philipp Hahn univentionstaff 2019-04-29 22:07:50 CEST
[master] eb7cbcd Bug #49218,Bug #45681,Bug #41669,Bug #47982,Bug #48152,Bug #48312,Bug #48527,Bug #48921,Bug #48973,Bug #48974,Bug #49057,Bug #49208,Bug #49026,Bug #46793: PUBLISH
 24 files changed, 108 insertions(+), 56 deletions(-)