Skip to content

Moving the tier naming content from Learn to Contribute #373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Moving the tier naming content from Learn to Contribute #373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc7dae3
Moving the tier naming content from Learn to Contribute
abhatt-rh Nov 27, 2023
fd46280
using internal xref instead of aliases for linking
abhatt-rh Dec 4, 2023
02c7f5e
fixing aliases
abhatt-rh Dec 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions content/learn/about-pattern-tiers-types.adoc → ...contribute/about-pattern-tiers-types.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
menu:
learn:
parent: Workflow
contribute:
title: Validated Pattern tiers
weight: 41
---
Expand All @@ -19,18 +18,18 @@ The different tiers of {solution-name-upstream} are designed to facilitate ongoi
|===
|Pattern tier|Description

|link:/requirements/sandbox/[{sandbox-tier-first}]
|link:/contribute/sandbox[{sandbox-tier-first}]
|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.

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.


|link:/requirements/tested/[{tested-tier-first}]
|link:/contribute/tested[{tested-tier-first}]
|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).

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.

|link:/requirements/maintained/[{maintained-tier-first}]
|link:/contribute/maintained[{maintained-tier-first}]
|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.

The patterns in this tier might have a formal release process with patch releases. They might have continuous integration (CI) automation testing.
Expand Down
5 changes: 3 additions & 2 deletions content/learn/implementation.adoc → content/contribute/implementation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
menu:
learn:
parent: Workflow
Comment on lines -3 to -4
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to add aliases for this past location?

contribute:
parent: Validated Pattern tiers
title: Implementation requirements
weight: 42
aliases: /learn/implementation/
aliases: /requirements/implementation/
---

Expand Down
10 changes: 5 additions & 5 deletions content/learn/maintained.adoc → content/contribute/maintained.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
menu:
learn:
parent: Workflow
contribute:
parent: Validated Pattern tiers
title: Validated Patterns - Maintained tier
weight: 45
aliases: /requirements/maintained/
aliases: /requirements/validated/
---

:toc:
Expand All @@ -29,14 +29,14 @@ Each {maintained} pattern represents an ongoing maintenance, support, and testin

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.

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.
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.


[id="requirements-maintained-tier"]
== Requirements for the {maintained} tier

The {maintained} patterns have deliverable and requirements in addition to those
specified for the link:/requirements/tested/[Tested tier].
specified for the link:/contribute/tested[Tested tier].

The requirements are categorized as follows:

Expand Down
9 changes: 4 additions & 5 deletions content/learn/sandbox.adoc → content/contribute/sandbox.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
menu:
learn:
parent: Workflow
contribute:
parent: Validated Pattern tiers
title: Validated Patterns - Sandbox tier
weight: 43
aliases: /requirements/community/
aliases: /requirements/sandbox/
---

:toc:
Expand Down Expand Up @@ -48,7 +47,7 @@ These are optional or desirable features, but their absence does not hinder the
=== Must
A {sandbox} pattern must continue to meet the following criteria to remain in the {sandbox} tier:

* A {sandbox} pattern must conform to the common technical link:/requirements/implementation/[implementation requirements].
* A {sandbox} pattern must conform to the common technical link:/contribute/implementation/[implementation requirements].
* A {sandbox} pattern must be able to be deployed onto a freshly deployed OpenShift cluster without prior modification or tuning.
* A {sandbox} pattern must include a top-level README file that highlights the business problem and how the pattern solves it.
* A {sandbox} pattern must include an architecture drawing. The specific tool or format is flexible as long as the meaning is clear.
Expand All @@ -69,4 +68,4 @@ The {solution-name-upstream} team commits to maintaining the framework, but will

* 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.
* A {sandbox} pattern can be listed on the link:https://validatedpatterns.io[https://validatedpatterns.io] site.
* A {sandbox} pattern meeting additional criteria can be nominated for promotion to the link:/learn/tested/[Tested tier].
* A {sandbox} pattern meeting additional criteria can be nominated for promotion to the link:/contribute/tested/[Tested tier].
5 changes: 2 additions & 3 deletions content/learn/test-artefacts.adoc → content/contribute/test-artefacts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
menu:
learn:
parent: Workflow
contribute:
parent: Validated Pattern tiers
title: Testing Artefacts
weight: 50
aliases: /requirements/tested/
---

:toc:
Expand Down
11 changes: 5 additions & 6 deletions content/learn/tested.adoc → content/contribute/tested.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
menu:
learn:
parent: Workflow
contribute:
parent: Validated Pattern tiers
title: Validated Patterns - Tested tier
weight: 44
aliases: /requirements/tested/
---

:toc:
Expand All @@ -18,7 +17,7 @@ include::modules/comm-attributes.adoc[]
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).

[id="nominating-a-pattern-for-tested-tier"]
== Nominating a a pattern for the {tested} tier
== Nominating a pattern for the {tested} tier

If your pattern qualifies or meets the criteria for {tested} tier, submit your nomination to mailto:[email protected][[email protected]].

Expand All @@ -35,7 +34,7 @@ In limited cases, the {solution-name-upstream} team may consider taking on that
[id="requirements-tested-tier"]
== Requirements for the {tested} tier

A {tested} patterns have deliverable and requirements in addition to those specified for the link:/requirements/sandbox/[Sandbox tier].
A {tested} patterns have deliverable and requirements in addition to those specified for the link:/contribute/sandbox/[Sandbox tier].

The requirements are categorized as follows:

Expand Down Expand Up @@ -67,7 +66,7 @@ Example: https://docs.google.com/document/d/12KQhdzjVIsxRURTnWAckiEMB3_96oWBjtlT

* A {tested} pattern must nominate at least one currently supported {rh-ocp} release to test against.
* A {tested} pattern must ensure the test plan passes at least once per quarter.
* 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-artefacts/[testing artefacts].
* 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-artefacts/[testing artefacts].

[NOTE]
====
Expand Down