Skip to content

Commit e08433a

Browse files
authored
Support provider evaluation guide, table and build script change (#217)
Signed-off-by: jp669844 <[email protected]>
1 parent 9a725aa commit e08433a

File tree

3 files changed

+275
-0
lines changed

3 files changed

+275
-0
lines changed

support_provider_evaluation_guide.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Zowe Support Provider Conformance Guide
2+
3+
Zowe Support Provider Conformance Guide is a set of self-certifying and self-service tests to help support Zowe framework.
4+
5+
This guide describes the requirements of the support conformance program. All Applicants complete sections in the **Core** section. Items marked **(best practice)** are considered best practices.
6+
7+
## Zowe Support Core Section - Zowe V1
8+
9+
1. **Zowe Binaries**
10+
11+
a. **Support Provider agrees:** to provide capable support for the given authenticated binary(s) of the Zowe core component(s) being attested to for the version(s) of Zowe defined in this version of the Zowe Support Provider Conformance program.
12+
13+
b. Capable Support is defined as having necessary hardware, software, and persons to diagnose issues, code solutions, test solutions, and provide fixes for issues in a reasonable timeframe.)
14+
15+
c. Zowe core component(s) are defined at [this site](https://github.com/zowe/community/blob/master/Technical-Steering-Committee/release.md#the-core-attribute).
16+
17+
d. Authenticated binaries are defined as those applicable to a given Zowe Core component and that passes the verification process (see [here](https://docs.zowe.org/stable/troubleshoot/verify-fingerprint.html#verify-zowe-runtime-directory)).
18+
19+
e. **Support Provider agrees:** to abide by the applicable license associated with the Zowe source code which produced the authenticated binaries.
20+
21+
2. **Zowe Security**
22+
23+
**Support Provider agrees:** to follow the Security Reporting Process outlined in the Zowe Docs Report Security Issues section when reporting security vulnerabilities (see [here](ttps://docs.zowe.org/stable/contribute/roadmap-contribute.html#report-security-issues)).
24+
25+
3. **Zowe Fix Strategy**
26+
27+
a. **Support Provider agrees:** to the extent that code is contributed upstream to the Zowe project by the Support Provider, the Support Provider would make such contributions adhere to the Zowe project contribution guidelines (see [here](https://github.com/zowe/community#contribute)).
28+
29+
b. **Support Provider agrees:** that it is able to both create and apply emergency fixes to the authenicated binary, including emergency fixes that may come from a third-party. Further, the Support Provider agrees to adhere to any requirements of the applicable license for the emergency fix. An emergency fix is defined as a change made to the components in the authenicated binary to resolve an issue which is deemed urgent or critical for use of the authenicated binary.
30+
31+
## Zowe Support Components Section - Zowe V1
32+
33+
- **Comprehensive Zowe Support Applicants:** Mark and complete ALL sections below
34+
- **Partial Zowe Support Applicants:** Mark and complete just the sections applicable to your Support Offering
35+
- [ ] Zowe API Mediation Layer
36+
- [ ] Zowe App Framework
37+
- [ ] Zowe Command Line Interface
38+
- [ ] Zowe Explorer
39+
40+
For each of the applicable COMPONENT SECTIONS selected, **Support Provider Applicant confirms Capable Support as defined in item (1)** (mark each applicable section as conformant).
41+
42+
1. **Zowe Component Requirements: API Mediation Layer**
43+
44+
**Support Provider confirms:** Capable Support as defined in item (1)
45+
46+
2. **Zowe Component Requirements: App Framework**
47+
48+
**Support Provider confirms:** Capable Support as defined in item (1)
49+
50+
3. **Zowe Component Requirements: Command Line Interface**
51+
52+
**Support Provider confirms:** Capable Support as defined in item (1)
53+
54+
4. **Zowe Component Requirements: Explorer**
55+
56+
**Support Provider confirms:** Capable Support as defined in item (1)
Lines changed: 216 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
1+
# Zowe Support Provider Conformance Guide
2+
3+
Zowe Support Provider Conformance Guide is a set of self-certifying and self-service tests to help support Zowe framework.
4+
5+
This guide describes the requirements of the support conformance program. All Applicants complete sections in the **Core** section. Items marked **(best practice)** are considered best practices.
6+
7+
- [Zowe Support Provider Conformance Guide](#zowe-support-provider-conformance-guide)
8+
- [Zowe Support Core Section](#zowe-support-core-section)
9+
- [Zowe Binaries](#zowe-binaries)
10+
- [Zowe Security](#zowe-security)
11+
- [Zowe Fix Strategy](#zowe-fix-strategy)
12+
- [Zowe Support Components Section](#zowe-support-components-section)
13+
- [Zowe Component Requirements: API Mediation Layer](#zowe-component-requirements--api-mediation-layer)
14+
- [Zowe Component Requirements: App Framework](#zowe-component-requirements--app-framework)
15+
- [Zowe Component Requirements: Command Line Interface](#zowe-component-requirements--command-line-interface)
16+
- [Zowe Component Requirements: Explorer](#zowe-component-requirements--explorer)
17+
18+
## Zowe Support Core Section
19+
20+
### Zowe Binaries
21+
22+
<table rules="all">
23+
<thead>
24+
<th style="background-color:#5555AA;">Item Number</th>
25+
<th style="background-color:#5555AA;">Program Version</th>
26+
<th style="background-color:#5555AA;">Required</th>
27+
<th style="background-color:#5555AA;">Best Practice</th>
28+
<th style="background-color:#5555AA;">Conformant (Yes/No)</th>
29+
<th style="background-color:#5555AA;">Criteria</th>
30+
</thead>
31+
32+
<tr>
33+
<th style="background-color:#555555">1</th>
34+
<th style="background-color:#555555">V1</th>
35+
<th style="background-color:#AAAAAA">x</th>
36+
<th style="background-color:#AAAAAA"></th>
37+
<th></th>
38+
<td> <b>Support Provider agrees:</b> to provide capable support for the given authenticated binary(s) of the Zowe core component(s) being attested to for the version(s) of Zowe defined in this version of the Zowe Support Provider Conformance program. <br/>
39+
Capable Support is defined as having necessary hardware, software, and persons to diagnose issues, code solutions, test solutions, and provide fixes for issues in a reasonable timeframe. <br/>
40+
Zowe core component(s) are defined at <a href="https://github.com/zowe/community/blob/master/Technical-Steering-Committee/release.md#the-core-attribute"> this site</a>. </br>
41+
Authenticated binaries are defined as those applicable to a given Zowe Core component and that passes the verification process (see <a href="https://docs.zowe.org/stable/troubleshoot/verify-fingerprint.html#verify-zowe-runtime-directory"> here</a>).
42+
</td>
43+
</tr>
44+
45+
<tr>
46+
<th style="background-color:#555555">2</th>
47+
<th style="background-color:#555555">V1</th>
48+
<th style="background-color:#AAAAAA">x</th>
49+
<th style="background-color:#AAAAAA"></th>
50+
<th></th>
51+
<td> <b>Support Provider agrees:</b> to abide by the applicable license associated with the Zowe source code which produced the authenticated binaries.
52+
</td>
53+
</tr>
54+
55+
</table>
56+
57+
### Zowe Security
58+
59+
<table rules="all">
60+
<thead>
61+
<th style="background-color:#5555AA;">Item Number</th>
62+
<th style="background-color:#5555AA;">Program Version</th>
63+
<th style="background-color:#5555AA;">Required</th>
64+
<th style="background-color:#5555AA;">Best Practice</th>
65+
<th style="background-color:#5555AA;">Conformant (Yes/No)</th>
66+
<th style="background-color:#5555AA;">Criteria</th>
67+
</thead>
68+
69+
<tr>
70+
<th style="background-color:#555555">3</th>
71+
<th style="background-color:#555555">V1</th>
72+
<th style="background-color:#AAAAAA">x</th>
73+
<th style="background-color:#AAAAAA"></th>
74+
<th></th>
75+
<td> <b>Support Provider agrees:</b> to follow the Security Reporting Process outlined in the Zowe Docs Report Security Issues section when reporting security vulnerabilities (see <a href="https://docs.zowe.org/stable/contribute/roadmap-contribute.html#report-security-issues">here</a>).
76+
</td>
77+
</tr>
78+
79+
</table>
80+
81+
### Zowe Fix Strategy
82+
83+
<table rules="all">
84+
<thead>
85+
<th style="background-color:#5555AA;">Item Number</th>
86+
<th style="background-color:#5555AA;">Program Version</th>
87+
<th style="background-color:#5555AA;">Required</th>
88+
<th style="background-color:#5555AA;">Best Practice</th>
89+
<th style="background-color:#5555AA;">Conformant (Yes/No)</th>
90+
<th style="background-color:#5555AA;">Criteria</th>
91+
</thead>
92+
93+
<tr>
94+
<th style="background-color:#555555">4</th>
95+
<th style="background-color:#555555">V1</th>
96+
<th style="background-color:#AAAAAA">x</th>
97+
<th style="background-color:#AAAAAA"></th>
98+
<th></th>
99+
<td> <b>Support Provider agrees:</b> to the extent that code is contributed upstream to the Zowe project by the Support Provider, the Support Provider would make such contributions adhere to the Zowe project contribution guidelines (see <a href="https://github.com/zowe/community#contribute">here</a>).
100+
</td>
101+
</tr>
102+
103+
<tr>
104+
<th style="background-color:#555555">5</th>
105+
<th style="background-color:#555555">V1</th>
106+
<th style="background-color:#AAAAAA">x</th>
107+
<th style="background-color:#AAAAAA"></th>
108+
<th></th>
109+
<td> <b>Support Provider agrees:</b> that it is able to both create and apply emergency fixes to the authenicated binary, including emergency fixes that may come from a third-party. Further, the Support Provider agrees to adhere to any requirements of the applicable license for the emergency fix. An emergency fix is defined as a change made to the components in the authenicated binary to resolve an issue which is deemed urgent or critical for use of the authenicated binary.
110+
</td>
111+
</tr>
112+
113+
</table>
114+
115+
## Zowe Support Components Section
116+
117+
- **Comprehensive Zowe Support Applicants:** Mark and complete ALL sections below
118+
- **Partial Zowe Support Applicants:** Mark and complete just the sections applicable to your Support Offering
119+
- [ ] Zowe API Mediation Layer
120+
- [ ] Zowe App Framework
121+
- [ ] Zowe Command Line Interface
122+
- [ ] Zowe Explorer
123+
124+
For each of the applicable COMPONENT SECTIONS selected, **Support Provider Applicant confirms Capable Support as defined in item (1)** (mark each applicable section as conformant in "Conformant" column).
125+
126+
### Zowe Component Requirements: API Mediation Layer
127+
128+
<table rules="all">
129+
<thead>
130+
<th style="background-color:#5555AA;">Item Number</th>
131+
<th style="background-color:#5555AA;">Program Version</th>
132+
<th style="background-color:#5555AA;">Required</th>
133+
<th style="background-color:#5555AA;">Best Practice</th>
134+
<th style="background-color:#5555AA;">Conformant</th>
135+
<th style="background-color:#5555AA;">Criteria</th>
136+
</thead>
137+
138+
<tr>
139+
<th style="background-color:#555555">6</th>
140+
<th style="background-color:#555555">V1</th>
141+
<th style="background-color:#AAAAAA">x</th>
142+
<th style="background-color:#AAAAAA"></th>
143+
<th></th>
144+
<td> <b>Support Provider confirms:</b> Capable Support as defined in item (1)
145+
</td>
146+
</tr>
147+
</table>
148+
149+
### Zowe Component Requirements: App Framework
150+
151+
<table rules="all">
152+
<thead>
153+
<th style="background-color:#5555AA;">Item Number</th>
154+
<th style="background-color:#5555AA;">Program Version</th>
155+
<th style="background-color:#5555AA;">Required</th>
156+
<th style="background-color:#5555AA;">Best Practice</th>
157+
<th style="background-color:#5555AA;">Conformant</th>
158+
<th style="background-color:#5555AA;">Criteria</th>
159+
</thead>
160+
161+
<tr>
162+
<th style="background-color:#555555">7</th>
163+
<th style="background-color:#555555">V1</th>
164+
<th style="background-color:#AAAAAA">x</th>
165+
<th style="background-color:#AAAAAA"></th>
166+
<th></th>
167+
<td> <b>Support Provider confirms:</b> Capable Support as defined in item (1)
168+
</td>
169+
</tr>
170+
</table>
171+
172+
### Zowe Component Requirements: Command Line Interface
173+
174+
<table rules="all">
175+
<thead>
176+
<th style="background-color:#5555AA;">Item Number</th>
177+
<th style="background-color:#5555AA;">Program Version</th>
178+
<th style="background-color:#5555AA;">Required</th>
179+
<th style="background-color:#5555AA;">Best Practice</th>
180+
<th style="background-color:#5555AA;">Conformant</th>
181+
<th style="background-color:#5555AA;">Criteria</th>
182+
</thead>
183+
184+
<tr>
185+
<th style="background-color:#555555">8</th>
186+
<th style="background-color:#555555">V1</th>
187+
<th style="background-color:#AAAAAA">x</th>
188+
<th style="background-color:#AAAAAA"></th>
189+
<th></th>
190+
<td> <b>Support Provider confirms:</b> Capable Support as defined in item (1)
191+
</td>
192+
</tr>
193+
</table>
194+
195+
### Zowe Component Requirements: Explorer
196+
197+
<table rules="all">
198+
<thead>
199+
<th style="background-color:#5555AA;">Item Number</th>
200+
<th style="background-color:#5555AA;">Program Version</th>
201+
<th style="background-color:#5555AA;">Required</th>
202+
<th style="background-color:#5555AA;">Best Practice</th>
203+
<th style="background-color:#5555AA;">Conformant</th>
204+
<th style="background-color:#5555AA;">Criteria</th>
205+
</thead>
206+
207+
<tr>
208+
<th style="background-color:#555555">9</th>
209+
<th style="background-color:#555555">V1</th>
210+
<th style="background-color:#AAAAAA">x</th>
211+
<th style="background-color:#AAAAAA"></th>
212+
<th></th>
213+
<td> <b>Support Provider confirms:</b> Capable Support as defined in item (1)
214+
</td>
215+
</tr>
216+
</table>

zowe_conformance/build.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,6 @@ pandoc participation_form.md -o Zowe.Conformance.Program.-.Participation.Form.pd
1111
pandoc terms_and_conditions.md -o Zowe.Conformance.Program.-.Terms.and.Conditions.pdf -f gfm --pdf-engine=wkhtmltopdf
1212
pandoc test_evaluation_guide.md -o Zowe.Conformance.Program.-.Test.Evaluation.Guide.pdf -f gfm --pdf-engine=wkhtmltopdf
1313
pandoc test_evaluation_guide_table.md -f gfm --pdf-engine=wkhtmltopdf | wkhtmltopdf -O Landscape - Zowe.Conformance.Program.-.Test.Evaluation.Guide.Table.pdf
14+
15+
pandoc support_provider_evaluation_guide.md -o Zowe.Support.Provider.-.Test.Evaluation.Guide.pdf -f gfm --pdf-engine=wkhtmltopdf
16+
pandoc support_provider_evaluation_guide_table.md -f gfm --pdf-engine=wkhtmltopdf | wkhtmltopdf -O Landscape - Zowe.Support.Provider.-.Test.Evaluation.Guide.Table.pdf

0 commit comments

Comments
 (0)