Skip to content

Commit

Permalink
Add README and build instructions, clean up minor formatting (#19)
Browse files Browse the repository at this point in the history
Signed-off-by: John Mertic <[email protected]>
  • Loading branch information
jmertic authored May 13, 2020
1 parent b9ea1c3 commit f96c75c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 10 deletions.
22 changes: 22 additions & 0 deletions zowe_conformance/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Zowe Conformance Program materials

This contains the following materials relevant to the Zowe Conformance Program:

- [Test Evaluation Guide table](/test_evaluation_guide_table.md)
- [Terms and Conditions](terms_and_conditions.md)
- [Participation Form](participation_form.md)
- [Brand Guidelines](brand_guidelines.pdf)
- [Test Evaluation Guide](test_evaluation_guide.md) - deprecated

The documents are the source versions; final version are made available on the [Zowe Conformance Program page](https://www.openmainframeproject.org/projects/zowe/conformance).

## Build instructions

Converting the markdown to PDF can be achieved leveraging [pandoc](https://pandoc.org/) and [wkhtmltopdf](https://wkhtmltopdf.org/) as shown below.

```bash
pandoc zowe_conformance/participation_form.md -o Zowe.Conformance.Program.-.Participation.Form.pdf -f gfm --pdf-engine=wkhtmltopdf
pandoc zowe_conformance/terms_and_conditions.md -o Zowe.Conformance.Program.-.Terms.and.Conditions.pdf -f gfm --pdf-engine=wkhtmltopdf
pandoc zowe_conformance/test_evaluation_guide.md -o Zowe.Conformance.Program.-.Test.Evaluation.Guide.pdf -f gfm --pdf-engine=wkhtmltopdf
pandoc zowe_conformance/test_evaluation_guide_table.md -o Zowe.Conformance.Program.-.Test.Evaluation.Guide.Table.pdf -f gfm --pdf-engine=wkhtmltopdf
```
17 changes: 7 additions & 10 deletions zowe_conformance/test_evaluation_guide_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The Zowe Conformance Test Evaluation Guide is a set of self-certify and self-ser
Below are the requirements for the three available conformance programs. Items marked **(required)** are required for achieving conformance in a given program. Items marked **(best practice)** are considered a best practice for conformant applications.

These Zowe Conformant criteria are applicable to the lastest Zowe v1 LTS Release.
#

- [Zowe API Mediation Layer - Zowe v1](#zowe-api-mediation-layer---zowe-v1)
- [Application Service](#application-service)
- [API Documentation](#api-documentation)
Expand All @@ -19,14 +19,12 @@ These Zowe Conformant criteria are applicable to the lastest Zowe v1 LTS Release
- [Directory and File Ownership Permissions](#directory-and-file-ownership-permissions)
- [Lifecycling as a Zowe address space](#lifecycling-as-a-zowe-address-space)
- [Support](#support)
#
- [Zowe CLI - Zowe v1](#zowe-cli---zowe-v1)
- [Infrastructure](#infrastructure)
- [Installation](#installation)
- [Naming](#naming)
- [Profiles](#profiles)
- [Support](#support)
#
- [Zowe App Framework - Zowe v1](#zowe-app-framework---zowe-v1)
- [Packaging](#packaging)
- [Web UIs All](#web-uis-all)
Expand All @@ -42,7 +40,6 @@ These Zowe Conformant criteria are applicable to the lastest Zowe v1 LTS Release
- [Directory and File Ownership Permissions](directory-and-file-ownership-permissions)
- [Lifecycling as a Zowe address space](#lifecycling-as-a-zowe-address-space)
- [Support](#support)
#

## Zowe API Mediation layer - Zowe v1

Expand All @@ -65,31 +62,31 @@ These Zowe Conformant criteria are applicable to the lastest Zowe v1 LTS Release
<th style="background-color:#AAAAAA"></th>
<th></th>
<td>An application service provides at least one service of UI register with discovery services</td>

</tr>
<tr>
<th style="background-color:#555555" rowspan=3>2</th>
<th style="background-color:#555555"></th>
<th style="background-color:#AAAAAA" colspan=2>Mark (a) or (b)</th>
<th style="background-color:#AAAAAA"></th>
<td style="text-align:center"><b>A service must be registered using one of the following methods</b><p style="color:red"> [please mark which one applies (a) or (b)</td>
<td style="text-align:center"><b>A service must be reigstered using one of the following methods</b><p style="color:red"> [please mark which one applies (a) or (b)</td>

</tr>
<tr>
<th style="background-color:#555555">v1</th>
<th style="background-color:#AAAAAA"></th>
<th style="background-color:#AAAAAA">x</th>
<th></th>
<td>a. Dynamic Registration</td>

</tr>
<tr>
<th style="background-color:#555555">v1</th>
<th style="background-color:#AAAAAA">x</th>
<th style="background-color:#AAAAAA"></th>
<th></th>
<td>b. Static Definition</td>

</tr>
<tr>
<th style="background-color:#555555">3</th>
Expand Down Expand Up @@ -132,7 +129,7 @@ These Zowe Conformant criteria are applicable to the lastest Zowe v1 LTS Release
<th style="background-color:#AAAAAA"></th>
<th></th>
<td>The published service URL must follow the gateway URL conventions</td>

</tr>
<tr>
<th style="background-color:#555555" rowspan=8>8</th>
Expand Down

0 comments on commit f96c75c

Please sign in to comment.