Bug 49057 - Add section about best practice recommendation for development and testing environment
Add section about best practice recommendation for development and testing en...
Status: CLOSED FIXED
Product: UCS extended documentation
Classification: Unclassified
Component: App Provider
unspecified
Other Linux
: P5 normal (vote)
: ---
Assigned To: Nico Gulden
Erik Damrose
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2019-03-22 09:05 CET by Nico Gulden
Modified: 2019-04-29 22:07 CEST (History)
2 users (show)

See Also:
What kind of report is it?: ---
What type of bug is this?: ---
Who will be affected by this bug?: ---
How will those affected feel about the bug?: ---
User Pain:
Enterprise Customer affected?:
School Customer affected?:
ISV affected?:
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-03-22 09:05:22 CET
The setup of a development environment to develop and test an app is not obvious to every app provider. The app provider documentation should include a best practice section about such an environment.

* Use virtualization, e.g. VirtualBox
* Prepare the environment before dealing with the app:
  * copy SSH key to system
  * activate the Test App Center
  * Optional: Login to docker account or use a different docker registry
  * Manually pull docker images with `docker pull`
* Use snapshots for different stages, e.g. after installation, after registration, after manual pull of docker images, etc.

The goal of the section is to show the app provider a way to minimize the necessary time to a minimum between iterations. Time consuming stuff are especially large downloads or repeatable little steps.
Comment 1 Nico Gulden univentionstaff 2019-03-22 11:07:37 CET
Added a new section in the App Life Cycle → Development chapter that briefly describes the most common best practices.

See the diff at https://git.knut.univention.de/univention/ucs/compare/4.4-0...ngulden%2F49057-app-docu-best-practice-dev-env

For QA, please build the documentation with Jenkins via http://jenkins.knut.univention.de:8080/job/BuildDocBookBranch/ and use the branch `ngulden/49057-app-docu-best-practice-dev-env`.

Please Reopen for Merge auf the QA.
Comment 2 Erik Damrose univentionstaff 2019-04-01 11:55:37 CEST
Verified. Reopening for merge to public documentation
Comment 3 Nico Gulden univentionstaff 2019-04-01 14:05:53 CEST
Merged to 4.4-0 branch.
Comment 4 Philipp Hahn univentionstaff 2019-04-29 22:07:55 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(-)