Changes for page Peer reviews

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,0 +1,1 @@
	1	+Running peer reviews inside eMagiz DevOps team

Parent

...	...	@@ -1,0 +1,1 @@
	1	+WebHome

Content

...	...	@@ -1,13 +1,8 @@
1	1	{{container}}{{container layoutStyle="columns"}}(((
2		-= Running peer reviews inside eMagiz DevOps team =
3		-
4	4	In this microlearning, we will take a look at peer reviews for eMagiz.
5	5
6	6	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7	7
8		-* Last update: April 22nd, 2021
9		-* Required reading time: 8 minutes
10		-
11	11	== 1. Prerequisites ==
12	12
13	13	* Basic knowledge of the eMagiz platform
...	...	@@ -27,8 +27,6 @@
27	27	* Architecture challenge and verification
28	28	* Find alternative solutions
29	29
30		-
31		-
32	32	== 3. Running peer reviews in eMagiz ==
33	33
34	34	=== 3.1 Considerations for reviewee ===
...	...	@@ -38,8 +38,8 @@
38	38	* Quickly explain the story / task / background
39	39	* Quickly show the working result if applicable / practical
40	40	* Talk through the solution while showing the models / code
41		- * Just trying to explain your work to someone else will help spot mistakes
42		- * Don’t show every single detail but try to highlight the important parts and/or details you’re less sure about. This takes time and experience to get “right” and is different depending on the story, the reviewee, the reviewer, the project, etc.
	34	+ ** Just trying to explain your work to someone else will help spot mistakes
	35	+ ** Don’t show every single detail but try to highlight the important parts and/or details you’re less sure about. This takes time and experience to get “right” and is different depending on the story, the reviewee, the reviewer, the project, etc.
43	43	* Always do a peer review, no exceptions. Making assumptions about the usefulness beforehand defeats the whole purpose.
44	44
45	45	=== 3.2 Considerations for reviewer ===
...	...	@@ -47,54 +47,52 @@
47	47	Here are some things to keep in mind when peer reviewing the work .
48	48
49	49	* Ask questions
50		- * How does this work?
51		- * Why did you decide to …?
52		- * Did you think about …?
	43	+ ** How does this work?
	44	+ ** Why did you decide to …?
	45	+ ** Did you think about …?
53	53	* Spot (incorrect) assumptions
54	54	* Check application of best practices – see next slide
55		- * Modelling / coding patterns
56		- * Naming conventions
57		- * Errors / warnings
	48	+ ** Modelling / coding patterns
	49	+ ** Naming conventions
	50	+ ** Errors / warnings
58	58	* Notice non-standard / unusual / abnormal things
59		- * Make sure this is documented, mainly for future changes. Annotations are very useful here.
	52	+ ** Make sure this is documented, mainly for future changes. Annotations are very useful here.
60	60
61	61	=== 3.3 Peer review items per ILM Phase ===
62	62
63	63	* Capture
64		- * 100% filled
65		- * Connection method clear
66		- * Authentication method clear
67		- * Definitions loaded
68		- * Sizing impact understood and valid
	57	+ ** 100% filled
	58	+ ** Connection method clear
	59	+ ** Authentication method clear
	60	+ ** Definitions loaded
	61	+ ** Sizing impact understood and valid
69	69	* Design
70		- * Check solution architecture validity
71		- * Design 100% filled and clear
72		- * CDM Root entity mapped
73		- * Set as mapped – avoid line mapping
74		- * Use annotation where possible
75		- * Proper flow and system settings
	63	+ ** Check solution architecture validity
	64	+ ** Design 100% filled and clear
	65	+ ** CDM Root entity mapped
	66	+ ** Set as mapped – avoid line mapping
	67	+ ** Use annotation where possible
	68	+ ** Proper flow and system settings
76	76	* Create
77		- * Validate routing
78		- * Generic error response flows
79		- * Check naming conventions flows, properties and XSD
80		- * Split messages in on-ramp – not later
	70	+ ** Validate routing
	71	+ ** Generic error response flows
	72	+ ** Check naming conventions flows, properties and XSD
	73	+ ** Split messages in on-ramp – not later
81	81	* Deploy
82		- * Check properties
83		- * Avoid too many different flow versions – max. 2
84		- * Remove test packages that are deployed
	75	+ ** Check properties
	76	+ ** Avoid too many different flow versions – max. 2
	77	+ ** Remove test packages that are deployed
85	85	* Manage
86		- * All alerts mapped to Customer Support
87		- * All messages can be explained
88		- * Avoid code mappings
89		- * Enable default alerts
	79	+ ** All alerts mapped to Customer Support
	80	+ ** All messages can be explained
	81	+ ** Avoid code mappings
	82	+ ** Enable default alerts
90	90	* Architecture
91		- * Deploy connector close to the source/target system
92		- * Ensure ACCP and PROD are exact copies
93		- * Cloud over on-premise
94		- * No hard-coded variable – use properties
	84	+ ** Deploy connector close to the source/target system
	85	+ ** Ensure ACCP and PROD are exact copies
	86	+ ** Cloud over on-premise
	87	+ ** No hard-coded variable – use properties
95	95
96		-
97		-
98	98	== 4. Assignment ==
99	99
100	100	See how peer reviews are currently implemented within the projects on which you work to see if you can learn something from the information you have gathered via this microlearning.
...	...	@@ -103,8 +103,6 @@
103	103
104	104	Peer reviews are instrumental in any DevOps team. Use the provided list as your team's peer review starting point and tune as you go along.
105	105
106		-
107		-
108	108	== 6. Suggested Additional Readings ==
109	109
110	110	You will find plenty background items available on the Internet.
...	...	@@ -111,6 +111,4 @@
111	111
112	112	== 7. Silent demonstration video ==
113	113
114		-As this is a more theoretical microlearning we have no video for this.
115		-
116		-)))((({{toc/}}))){{/container}}{{/container}}
	103	+As this is a more theoretical microlearning we have no video for this.)))((({{toc/}}))){{/container}}{{/container}}