From dc7dae39c68e05d6bd70e863fe4a04ac995ed49a Mon Sep 17 00:00:00 2001 From: Avani Bhatt Date: Mon, 27 Nov 2023 11:21:31 +0000 Subject: [PATCH 1/3] Moving the tier naming content from Learn to Contribute --- content/{learn => contribute}/about-pattern-tiers-types.adoc | 3 +-- content/{learn => contribute}/implementation.adoc | 4 ++-- content/{learn => contribute}/maintained.adoc | 4 ++-- content/{learn => contribute}/sandbox.adoc | 4 ++-- content/{learn => contribute}/test-artefacts.adoc | 4 ++-- content/{learn => contribute}/tested.adoc | 4 ++-- 6 files changed, 11 insertions(+), 12 deletions(-) rename content/{learn => contribute}/about-pattern-tiers-types.adoc (98%) rename content/{learn => contribute}/implementation.adoc (99%) rename content/{learn => contribute}/maintained.adoc (98%) rename content/{learn => contribute}/sandbox.adoc (98%) rename content/{learn => contribute}/test-artefacts.adoc (97%) rename content/{learn => contribute}/tested.adoc (99%) diff --git a/content/learn/about-pattern-tiers-types.adoc b/content/contribute/about-pattern-tiers-types.adoc similarity index 98% rename from content/learn/about-pattern-tiers-types.adoc rename to content/contribute/about-pattern-tiers-types.adoc index acf8014a6..e43579224 100644 --- a/content/learn/about-pattern-tiers-types.adoc +++ b/content/contribute/about-pattern-tiers-types.adoc @@ -1,7 +1,6 @@ --- menu: - learn: - parent: Workflow + contribute: title: Validated Pattern tiers weight: 41 --- diff --git a/content/learn/implementation.adoc b/content/contribute/implementation.adoc similarity index 99% rename from content/learn/implementation.adoc rename to content/contribute/implementation.adoc index 3f0e3fe83..3c423d091 100644 --- a/content/learn/implementation.adoc +++ b/content/contribute/implementation.adoc @@ -1,7 +1,7 @@ --- menu: - learn: - parent: Workflow + contribute: + parent: Validated Pattern tiers title: Implementation requirements weight: 42 aliases: /requirements/implementation/ diff --git a/content/learn/maintained.adoc b/content/contribute/maintained.adoc similarity index 98% rename from content/learn/maintained.adoc rename to content/contribute/maintained.adoc index 6bd85ff44..732066019 100644 --- a/content/learn/maintained.adoc +++ b/content/contribute/maintained.adoc @@ -1,7 +1,7 @@ --- menu: - learn: - parent: Workflow + contribute: + parent: Validated Pattern tiers title: Validated Patterns - Maintained tier weight: 45 aliases: /requirements/maintained/ diff --git a/content/learn/sandbox.adoc b/content/contribute/sandbox.adoc similarity index 98% rename from content/learn/sandbox.adoc rename to content/contribute/sandbox.adoc index 2d49b8708..632bd11b6 100644 --- a/content/learn/sandbox.adoc +++ b/content/contribute/sandbox.adoc @@ -1,7 +1,7 @@ --- menu: - learn: - parent: Workflow + contribute: + parent: Validated Pattern tiers title: Validated Patterns - Sandbox tier weight: 43 aliases: /requirements/community/ diff --git a/content/learn/test-artefacts.adoc b/content/contribute/test-artefacts.adoc similarity index 97% rename from content/learn/test-artefacts.adoc rename to content/contribute/test-artefacts.adoc index b82a1b021..46687eab3 100644 --- a/content/learn/test-artefacts.adoc +++ b/content/contribute/test-artefacts.adoc @@ -1,7 +1,7 @@ --- menu: - learn: - parent: Workflow + contribute: + parent: Validated Pattern tiers title: Testing Artefacts weight: 50 aliases: /requirements/tested/ diff --git a/content/learn/tested.adoc b/content/contribute/tested.adoc similarity index 99% rename from content/learn/tested.adoc rename to content/contribute/tested.adoc index 20aa49782..f3cf19dda 100644 --- a/content/learn/tested.adoc +++ b/content/contribute/tested.adoc @@ -1,7 +1,7 @@ --- menu: - learn: - parent: Workflow + contribute: + parent: Validated Pattern tiers title: Validated Patterns - Tested tier weight: 44 aliases: /requirements/tested/ From fd4628043cf1f453d55895aafb4b2926821c1f38 Mon Sep 17 00:00:00 2001 From: Avani Bhatt Date: Mon, 4 Dec 2023 11:40:57 +0530 Subject: [PATCH 2/3] using internal xref instead of aliases for linking --- content/contribute/about-pattern-tiers-types.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/contribute/about-pattern-tiers-types.adoc b/content/contribute/about-pattern-tiers-types.adoc index e43579224..660b2226f 100644 --- a/content/contribute/about-pattern-tiers-types.adoc +++ b/content/contribute/about-pattern-tiers-types.adoc @@ -18,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. From 02c7f5edb9741d48d8a8cc663262af3efcdd2e5a Mon Sep 17 00:00:00 2001 From: Avani Bhatt Date: Mon, 4 Dec 2023 12:35:05 +0530 Subject: [PATCH 3/3] fixing aliases --- content/contribute/implementation.adoc | 1 + content/contribute/maintained.adoc | 6 +++--- content/contribute/sandbox.adoc | 5 ++--- content/contribute/test-artefacts.adoc | 1 - content/contribute/tested.adoc | 7 +++---- 5 files changed, 9 insertions(+), 11 deletions(-) diff --git a/content/contribute/implementation.adoc b/content/contribute/implementation.adoc index 3c423d091..39a76fa3f 100644 --- a/content/contribute/implementation.adoc +++ b/content/contribute/implementation.adoc @@ -4,6 +4,7 @@ menu: parent: Validated Pattern tiers title: Implementation requirements weight: 42 +aliases: /learn/implementation/ aliases: /requirements/implementation/ --- diff --git a/content/contribute/maintained.adoc b/content/contribute/maintained.adoc index 732066019..6a70a9da1 100644 --- a/content/contribute/maintained.adoc +++ b/content/contribute/maintained.adoc @@ -4,7 +4,7 @@ menu: parent: Validated Pattern tiers title: Validated Patterns - Maintained tier weight: 45 -aliases: /requirements/maintained/ +aliases: /requirements/validated/ --- :toc: @@ -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: diff --git a/content/contribute/sandbox.adoc b/content/contribute/sandbox.adoc index 632bd11b6..204351bdb 100644 --- a/content/contribute/sandbox.adoc +++ b/content/contribute/sandbox.adoc @@ -5,7 +5,6 @@ menu: title: Validated Patterns - Sandbox tier weight: 43 aliases: /requirements/community/ -aliases: /requirements/sandbox/ --- :toc: @@ -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. @@ -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]. diff --git a/content/contribute/test-artefacts.adoc b/content/contribute/test-artefacts.adoc index 46687eab3..adb10b8b6 100644 --- a/content/contribute/test-artefacts.adoc +++ b/content/contribute/test-artefacts.adoc @@ -4,7 +4,6 @@ menu: parent: Validated Pattern tiers title: Testing Artefacts weight: 50 -aliases: /requirements/tested/ --- :toc: diff --git a/content/contribute/tested.adoc b/content/contribute/tested.adoc index f3cf19dda..be059a52e 100644 --- a/content/contribute/tested.adoc +++ b/content/contribute/tested.adoc @@ -4,7 +4,6 @@ menu: parent: Validated Pattern tiers title: Validated Patterns - Tested tier weight: 44 -aliases: /requirements/tested/ --- :toc: @@ -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:validatedpatterns@googlegroups.com[validatedpatterns@googlegroups.com]. @@ -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: @@ -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] ====