You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Moved patterns from learn to contribute section (#508)
* Moved patterns from learn to contribute section
* Corrected the tested tier title
* moved content under contribute folder
* moved testing artifacts from learn to contribute section
Copy file name to clipboardExpand all lines: content/contribute/maintained.adoc
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
---
2
2
menu:
3
-
learn:
4
-
parent: Workflow
3
+
contribute:
4
+
parent: Contributing and managing patterns
5
5
title: Validated Patterns - Maintained tier
6
-
weight: 65
7
-
aliases: /requirements/maintained/
6
+
weight: 55
7
+
aliases: /contribute/maintained/
8
8
---
9
9
10
10
:toc:
11
-
11
+
:imagesdir: /images
12
12
:_content-type: ASSEMBLY
13
13
include::modules/comm-attributes.adoc[]
14
14
@@ -29,14 +29,14 @@ Each {maintained} pattern represents an ongoing maintenance, support, and testin
29
29
30
30
For this reason we have designed the tiers and our processes to facilitate this to occur outside of the team by any sufficiently motivated party, including other parts of Red Hat, partners, and even customers.
31
31
32
-
In limited cases, the {solution-name-upstream} team may consider taking on that work, however, it is recommended that you contact the team at least 4 weeks prior to the end of a given quarter for the necessary work to be considered as part of the following quarter's planning process.
32
+
In limited cases, the {solution-name-upstream} team may consider taking on that work, however, it is recommended that you contact the team at least 4 weeks before the end of a given quarter for the necessary work to be considered as part of the following quarter's planning process.
33
33
34
34
35
35
[id="requirements-maintained-tier"]
36
36
== Requirements for the {maintained} tier
37
37
38
38
The {maintained} patterns have deliverable and requirements in addition to those
39
-
specified for the link:/requirements/tested/[Tested tier].
39
+
specified for the link:/contribute/tested/[Tested tier].
40
40
41
41
The requirements are categorized as follows:
42
42
@@ -52,15 +52,15 @@ These are optional or desirable features, but their absence does not hinder the
52
52
53
53
A {maintained} pattern must continue to meet the following criteria to remain in {maintained} tier:
54
54
55
-
* A {maintained} pattern must conform to the common technical link:/requirements/implementation/[implementation requirements].
56
-
* A {maintained} pattern must only make use of components that are either supported, or easily substituted for supportable equivalents, for example, HashiCorp vault which has community and enterprise variants.
57
-
* A {maintained} pattern must *not* rely on functionality in tech-preview, or hidden behind feature gates.
58
-
* A {maintained} pattern must have their architectures reviewed by a representative of each Red Hat product they consume to ensure consistency with the product teams` intentions and roadmaps. Your patterns SME (eg. services rep) can help coordinate this.
59
-
* A {maintained} pattern must include a link to a hosted presentation (Google Slides or similar) intended to promote the solution. The focus should be on the architecture and business problem being solved. No customer, or otherwise sensitive, information should be included.
60
-
* A {maintained} pattern must include test plan automation that runs on every change to the pattern, or a schedule no less frequently than once per week.
61
-
* A {maintained} pattern must be tested on all currently supported {rh-ocp} extended update support (EUS) releases.
62
-
* A {maintained} pattern must fix breakage in timely manner.
63
-
* A {maintained} pattern must document their support policy.
55
+
. A {maintained} pattern must conform to the common technical link:/contribute/implementation/[implementation requirements].
56
+
. A {maintained} pattern must only make use of components that are either supported, or easily substituted for supportable equivalents, for example, HashiCorp vault which has community and enterprise variants.
57
+
. A {maintained} pattern must *not* rely on functionality in tech-preview, or hidden behind feature gates.
58
+
. A {maintained} pattern must have their architectures reviewed by a representative of each Red Hat product they consume to ensure consistency with the product teams` intentions and roadmaps. Your patterns SME (eg. services rep) can help coordinate this.
59
+
. A {maintained} pattern must include a link to a hosted presentation (Google Slides or similar) intended to promote the solution. The focus should be on the architecture and business problem being solved. No customer, or otherwise sensitive, information should be included.
60
+
. A {maintained} pattern must include test plan automation that runs on every change to the pattern, or a schedule no less frequently than once per week.
61
+
. A {maintained} pattern must be tested on all currently supported {rh-ocp} extended update support (EUS) releases.
62
+
. A {maintained} pattern must fix breakage in timely manner.
63
+
. A {maintained} pattern must document their support policy.
64
64
+
65
65
66
66
The individual products used in a {solution-name-upstream} are backed by the full {redhat} support experience conditional on the customer's subscription to those products, and the individual products`s support policy.
@@ -79,4 +79,4 @@ The {maintained} patterns *do not* imply an obligation of support for partner or
79
79
[id="can-maintained-tier"]
80
80
=== Can
81
81
82
-
* If you are creating {solution-name-upstream}, you can provide your own SLA.
82
+
. If you are creating {solution-name-upstream}, you can provide your own SLA.
Copy file name to clipboardExpand all lines: content/contribute/sandbox.adoc
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,14 @@
1
1
---
2
2
menu:
3
-
learn:
4
-
parent: Workflow
3
+
contribute:
4
+
parent: Contributing and managing patterns
5
5
title: Validated Patterns - Sandbox tier
6
-
weight: 63
7
-
aliases: /requirements/community/
8
-
aliases: /requirements/sandbox/
6
+
weight: 53
7
+
aliases: /contribute/sandbox/
9
8
---
10
9
11
10
:toc:
12
-
11
+
:imagesdir: /images
13
12
:_content-type: ASSEMBLY
14
13
include::modules/comm-attributes.adoc[]
15
14
@@ -48,15 +47,15 @@ These are optional or desirable features, but their absence does not hinder the
48
47
=== Must
49
48
A {sandbox} pattern must continue to meet the following criteria to remain in the {sandbox} tier:
50
49
51
-
* A {sandbox} pattern must conform to the common technical link:/requirements/implementation/[implementation requirements].
52
-
* A {sandbox} pattern must be able to be deployed onto a freshly deployed OpenShift cluster without prior modification or tuning.
53
-
* A {sandbox} pattern must include a top-level README file that highlights the business problem and how the pattern solves it.
54
-
* A {sandbox} pattern must include an architecture drawing. The specific tool or format is flexible as long as the meaning is clear.
55
-
* A {sandbox} pattern must undergo an informal technical review by a community leader to ensure that it meets basic reuse standards.
56
-
* A {sandbox} pattern must undergo an informal architecture review by a community leader to ensure that the solution has the right components, and they are generally being used as intended. For example, not using a database as a message bus.
50
+
. A {sandbox} pattern must conform to the common technical link:/contribute/implementation/[implementation requirements].
51
+
. A {sandbox} pattern must be able to be deployed onto a freshly deployed OpenShift cluster without prior modification or tuning.
52
+
. A {sandbox} pattern must include a top-level README file that highlights the business problem and how the pattern solves it.
53
+
. A {sandbox} pattern must include an architecture drawing. The specific tool or format is flexible as long as the meaning is clear.
54
+
. A {sandbox} pattern must undergo an informal technical review by a community leader to ensure that it meets basic reuse standards.
55
+
. A {sandbox} pattern must undergo an informal architecture review by a community leader to ensure that the solution has the right components, and they are generally being used as intended. For example, not using a database as a message bus.
57
56
+
58
57
As community leaders, contributions from within {redhat} might be subject to a higher level of scrutiny. While we strive to be inclusive, the community will have quality standards and generally using the framework does not automatically imply a solution is suitable for the community to endorse/publish.
59
-
* A {sandbox} pattern must document their support policy.
58
+
. A {sandbox} pattern must document their support policy.
60
59
61
60
[NOTE]
62
61
====
@@ -67,6 +66,6 @@ The {solution-name-upstream} team commits to maintaining the framework, but will
67
66
[id="can-sandbox-tier"]
68
67
=== Can
69
68
70
-
* A {sandbox} pattern (including works-in-progress) can be hosted in the link:https://github.com/validatedpatterns-sandbox[https://github.com/validatedpatterns-sandbox] GitHub organization.
71
-
* A {sandbox} pattern can be listed on the link:https://validatedpatterns.io[https://validatedpatterns.io] site.
72
-
* A {sandbox} pattern meeting additional criteria can be nominated for promotion to the link:/learn/tested/[Tested tier].
69
+
. A {sandbox} pattern (including works-in-progress) can be hosted in the link:https://github.com/validatedpatterns-sandbox[https://github.com/validatedpatterns-sandbox] GitHub organization.
70
+
. A {sandbox} pattern can be listed on the link:https://validatedpatterns.io[https://validatedpatterns.io] site.
71
+
. A {sandbox} pattern meeting additional criteria can be nominated for promotion to the link:/contribute/tested/[Tested tier].
The {tested} tier provides you with additional collateral and reassurance that the pattern was known to be recently working on at least one recent version of {rh-ocp}. Inclusion in this tier requires some additional work for the pattern's owner, which might be a partner or a sufficiently motivated subject matter expert (SME).
19
19
20
20
[id="nominating-a-pattern-for-tested-tier"]
21
-
== Nominating a a pattern for the {tested} tier
21
+
== Nominating a pattern for the {tested} tier
22
22
23
23
If your pattern qualifies or meets the criteria for {tested} tier, submit your nomination to mailto:[email protected][[email protected]].
24
24
@@ -35,7 +35,7 @@ In limited cases, the {solution-name-upstream} team may consider taking on that
35
35
[id="requirements-tested-tier"]
36
36
== Requirements for the {tested} tier
37
37
38
-
A {tested} patterns have deliverable and requirements in addition to those specified for the link:/requirements/sandbox/[Sandbox tier].
38
+
A {tested} patterns have deliverable and requirements in addition to those specified for the link:/contribute/sandbox/[Sandbox tier].
39
39
40
40
The requirements are categorized as follows:
41
41
@@ -51,23 +51,23 @@ These are optional or desirable features, but their absence does not hinder the
51
51
52
52
A {tested} pattern must continue to meet the following criteria to remain in the {tested} tier:
53
53
54
-
* A {tested} pattern must conform to the common technical link:/requirements/implementation/[implementation requirements].
55
-
* A {tested} pattern must be meaningful without specialized hardware, including flavors of architectures not explicitly supported.
54
+
. A {tested} pattern must conform to the common technical link:/contribute/implementation/[implementation requirements].
55
+
. A {tested} pattern must be meaningful without specialized hardware, including flavors of architectures not explicitly supported.
56
56
+
57
57
Qualification is a {solution-name-upstream} Technical Oversight Committee (TOC) decision with input from the pattern owner.
58
-
* A {tested} pattern must have their implementation reviewed by the patterns team to ensure that it is sufficiently flexible to function across a variety of platforms, customer environments, and any relevant verticals.
59
-
* A {tested} pattern must include a standardized architecture drawing, created with (or at least conforming to) the standard {solution-name-upstream} tooling.
60
-
* A {tested} pattern must include a written guide for others to follow when demonstrating the pattern.
61
-
* A {tested} pattern must include a test plan covering all features or attributes being highlighted by the demonstration guide. Negative flow tests (such as resiliency or data retention in the presence of network outages) are also limited to scenarios covered by the demonstration guide.
58
+
. A {tested} pattern must have their implementation reviewed by the patterns team to ensure that it is sufficiently flexible to function across a variety of platforms, customer environments, and any relevant verticals.
59
+
. A {tested} pattern must include a standardized architecture drawing, created with (or at least conforming to) the standard {solution-name-upstream} tooling.
60
+
. A {tested} pattern must include a written guide for others to follow when demonstrating the pattern.
61
+
. A {tested} pattern must include a test plan covering all features or attributes being highlighted by the demonstration guide. Negative flow tests (such as resiliency or data retention in the presence of network outages) are also limited to scenarios covered by the demonstration guide.
62
62
+
63
63
The test plan must define how to validate if the pattern has been successfully deployed and is functionally operational.
64
64
Example: link:https://docs.google.com/document/d/12KQhdzjVIsxRURTnWAckiEMB3_96oWBjtlTXi1q73cg/view[Validating an Industrial Edge Deployment].
65
-
65
+
+
66
66
//TODO: Convert above link to adoc
67
67
68
-
* A {tested} pattern must nominate at least one currently supported {rh-ocp} release to test against.
69
-
* A {tested} pattern must ensure the test plan passes at least once per quarter.
70
-
* A {tested} pattern must create a publicly available JSON file (for example, in an AWS bucket) that records the result of the latest test for each combination of pattern, platform, and {rh-ocp} version. See link:/learn/test-artifacts/[testing artifacts].
68
+
. A {tested} pattern must nominate at least one currently supported {rh-ocp} release to test against.
69
+
. A {tested} pattern must ensure the test plan passes at least once per quarter.
70
+
. A {tested} pattern must create a publicly available JSON file (for example, in an AWS bucket) that records the result of the latest test for each combination of pattern, platform, and {rh-ocp} version. See link:/contribute/test-artifacts/[testing artifacts].
71
71
72
72
[NOTE]
73
73
====
@@ -77,8 +77,8 @@ A {tested} pattern *does not* imply an obligation of support for partner or comm
77
77
[id="should-tested-tier"]
78
78
=== Should
79
79
80
-
* A {tested} pattern should be broadly applicable.
81
-
* A {tested} pattern should focus on functionality not performance.
80
+
. A {tested} pattern should be broadly applicable.
81
+
. A {tested} pattern should focus on functionality not performance.
82
82
83
83
[id="can-tested-tier"]
84
84
=== Can
@@ -88,4 +88,4 @@ Teams creating {tested} pattern can provide their own service level agreement (S
88
88
A technical document for Quality Engineering (QE) team that defines how to validate if the pattern has been successfully deployed and is functionally operational.
89
89
For example, see link:https://docs.google.com/document/d/12KQhdzjVIsxRURTnWAckiEMB3_96oWBjtlTXi1q73cg/view[Validating an Industrial Edge Deployment].
90
90
91
-
A {tested} pattern meeting additional criteria can be nominated for promotion to the link:/learn/maintained/[Maintained tier].
91
+
A {tested} pattern meeting additional criteria can be nominated for promotion to the link:/contribute/maintained/[Maintained tier].
|A pattern categorized under the {sandbox} tier provides you with an entry point to onboard to {solution-name-upstream}. The minimum requirement to qualify for the {sandbox} tier is to start with the patterns framework and include minimal documentation.
27
27
28
28
The patterns in this tier might be in a work-in-progress state; and they might have been manually tested on a limited set of platforms.
29
29
30
30
31
31
|image:pattern-tier-tested.png[]
32
-
|link:/requirements/tested/[{tested-tier-first}]
32
+
|link:/contribute/tested/[{tested-tier-first}]
33
33
|A pattern categorized under the {tested} tier implies that the pattern might have been recently working on at least one recent version of {rh-ocp}. Qualifying for this tier might require additional work for the pattern’s owner, who might be a partner or a motivated subject matter expert (SME).
34
34
35
35
The patterns in this tier might have a defined business problem with a demonstration. The patterns might have a manual or automated test plan, which passes at least once for each new {rh-ocp} minor version.
|A pattern categorized under the {maintained} tier implies that the pattern might have been functional on all currently supported extended update support (EUS) versions of {rh-ocp}. Qualifying for this tier might require additional work for the pattern’s owner who might be a partner or a motivated SME.
40
40
41
41
The patterns in this tier might have a formal release process with patch releases. They might have continuous integration (CI) automation testing.
0 commit comments