diff --git a/AGENTS.md b/AGENTS.md index ff144139ce..b84cdceb71 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -64,7 +64,7 @@ All content files use YAML frontmatter between `---` delimiters. Fields vary by title: Pattern Name date: 2025-10-24 summary: Short description of the pattern -tier: sandbox # sandbox | tested | maintained +tier: sandbox # sandbox | tested | maintained | archived rh_products: - Red Hat OpenShift Container Platform industries: diff --git a/archetypes/pattern/_index.adoc b/archetypes/pattern/_index.adoc index c3e0633d84..aacdfcbcda 100644 --- a/archetypes/pattern/_index.adoc +++ b/archetypes/pattern/_index.adoc @@ -20,8 +20,9 @@ links: bugs: feedback: https://docs.google.com/forms/d/e/1FAIpQLScI76b6tD1WyPu2-d_9CCVDr3Fu5jYERthqLKJDUGwqBg7Vcg/viewform -# Set tier to one of sandbox, tested, or maintained. If empty, the default -# is sandbox +# Set tier to one of sandbox, tested, maintained, or archived. If empty, the +# default is sandbox. Use archived only when Validated Patterns maintainers +# have archived the pattern repository; archived is a terminal state. # tier: sandbox # # The following parameters are only used for maintained validated patterns. diff --git a/content/ci/_index.md b/content/ci/_index.md index 6a84308c6f..55df3ad0bf 100644 --- a/content/ci/_index.md +++ b/content/ci/_index.md @@ -8,3 +8,5 @@ menu: --- These are the latest results of the Validated Patterns CI test runs. + +This dashboard excludes patterns in the Archived tier because they are no longer under active development or continuous integration. diff --git a/content/contribute/archived.adoc b/content/contribute/archived.adoc new file mode 100644 index 0000000000..50c83141e4 --- /dev/null +++ b/content/contribute/archived.adoc @@ -0,0 +1,57 @@ +--- +menu: + contribute: + parent: Contributing and managing patterns +title: Validated Patterns - Archived tier +weight: 56 +aliases: /contribute/archived/ +--- + +:toc: +:imagesdir: /images +:_content-type: ASSEMBLY +include::modules/comm-attributes.adoc[] + +[id="about-archived-tier"] += About the {archived-tier-first} + +A pattern in the {archived} tier is no longer under active development. +Validated Patterns maintainers move a pattern to this tier when the pattern's source repository has been archived on GitHub. +Archived patterns remain documented for reference, but avoid using them for new deployments. + +[IMPORTANT] +==== +The {archived} tier is a terminal state. +Patterns do not move from {archived} back to {sandbox}, {tested}, or {maintained}. +==== + +[id="moving-a-pattern-to-archived-tier"] +== Moving a pattern to the {archived} tier + +Only Validated Patterns maintainers decide when a pattern moves to the {archived} tier. +A pattern does not move to {archived} automatically. + +Typical conditions before archiving include: + +* The pattern repository has been archived on GitHub. +* No further development or maintenance is planned. + +After a pattern is archived: + +* The pattern page and related documentation remain available. +* Pattern cards use a desaturated style, and an Archived banner appears on the pattern documentation pages. +* The Install resource link on the pattern page is disabled. +* The pattern is hidden from the default patterns catalog view until you select the Archived filter. +* The pattern is not included in the homepage tier accordion. + +[id="requirements-archived-tier"] +== Requirements for the {archived} tier + +Must:: + +[id="must-archived-tier"] +=== Must + +. The pattern repository must be archived on GitHub. +. The pattern frontmatter must set `tier: archived`. +. Keep pattern documentation published so existing users can find historical guidance. diff --git a/content/learn/about-pattern-tiers-types.adoc b/content/learn/about-pattern-tiers-types.adoc index af3235e84a..e1a483b38b 100644 --- a/content/learn/about-pattern-tiers-types.adoc +++ b/content/learn/about-pattern-tiers-types.adoc @@ -16,7 +16,7 @@ include::modules/comm-attributes.adoc[] = Validated Pattern tiers in-depth [role="_abstract"] -Patterns are categorized into distinct tiers: *Sandbox*, *Tested*, and *Maintained*. +Patterns are categorized into distinct tiers: *Sandbox*, *Tested*, *Maintained*, and *Archived*. The different tiers of Validated Patterns are designed to facilitate ongoing maintenance, support, and testing efforts for a pattern. The tiering system emphasizes the requirements a pattern meets, rather than focusing on who does the maintenance. @@ -56,6 +56,15 @@ The following table describes each pattern tier and a short description of what * Continuously validated to ensure all integrated components work seamlessly together as good or better after upgrades. * Includes only supported services and components. +|image:pattern-tier-archived.png[Archived tier] +|xref:#archived-tier[{archived-tier-first}] +|An Archived pattern is: + +* No longer actively developed. +* Kept in the documentation site for reference, with an Archived notice on its pages. +* Hidden from the default patterns catalog until you select the Archived filter. +* Not recommended for new deployments. + |=== [id="sandbox-tier"] @@ -138,102 +147,151 @@ Following are some examples of the patterns in the maintained tier: * link:/ansible-edge-gitops[Ansible Edge GitOps] * link:/multicloud-gitops[Multicloud GitOps] + +[id="archived-tier"] +== Archived tier + +The Archived tier is for patterns that Validated Patterns maintainers have retired from active development. +A pattern moves to this tier when its source repository has been archived on GitHub. +Archiving is a manual decision by Validated Patterns maintainers and is a terminal state. Patterns do not move from Archived back to another tier. + +Documentation for archived patterns remains available for reference. +Pattern pages show an Archived banner, Install links are inactive, and pattern cards appear desaturated in the catalog when you enable the Archived filter. + +Following are the main characteristics of patterns in the archived tier: + +* *Repository status*: The pattern repository is archived on GitHub. +* *No active maintenance*: No further development, CI, or support expectations apply to the pattern. +* *Reference documentation*: Existing documentation remains published for historical reference. +* *Catalog visibility*: Archived patterns are hidden from the default patterns list until you select the Archived filter. + +Following are some examples of the patterns in the archived tier: + * link:/medical-diagnosis[Medical Diagnosis] +[role="_additional-resources"] +.Additional resources + +* For more information about the Archived tier process, see link:/contribute/archived/[Archived tier]. + [id="feature-breakdown-by-tiers"] == Feature breakdown by tiers -[cols="4,^1,^1,^1", options="header"] +[cols="4,^1,^1,^1,^1", options="header"] |=== -| Feature | Sandbox | Tested | Maintained +| Feature | Sandbox | Tested | Maintained | Archived | *Deploys on fresh OpenShift without modification* | ✓ | ✓ | ✓ +| - | *Useful without private/closed source apps* | ✓ | ✓ | ✓ +| - | *Open contribution and collaboration* | ✓ | ✓ | ✓ +| - | *Documented support policy* | ✓ | ✓ | ✓ +| - | *README with problem statement* | ✓ | ✓ | ✓ +| ✓ | *Includes architecture diagram* | ✓ | ✓ | ✓ +| ✓ | *Business use case with demo* | - | ✓ | ✓ +| - | *Standardized architecture diagram and written guide* | - | ✓ | ✓ +| - | *Test plan passes at least once per quarter* | - | ✓ | ✓ +| - | *Tested on at least 1 supported OCP version* | - | ✓ | ✓ +| - | *Publicly visible test results (JSON)* | - | ✓ | ✓ +| - | *Implementation review* | - | ✓ | ✓ +| - | *Automated CI pipeline (every change or weekly)* | - | - | ✓ +| - | *Tested on 2 latest EUS and active interim versions* | - | - | ✓ +| - | *Tested on pre-release bits* | - | - | ✓ +| - | *Timely fixes for breakage* | - | - | ✓ +| - | *No Tech Preview or feature-gated features* | - | - | ✓ +| - | *Includes only supported services and components* | - | - | ✓ +| - + +| *Repository archived; docs kept for reference* +| - +| - +| - +| ✓ |=== diff --git a/content/patterns/medical-diagnosis/_index.adoc b/content/patterns/medical-diagnosis/_index.adoc index ef20aab824..92df6ecdd5 100644 --- a/content/patterns/medical-diagnosis/_index.adoc +++ b/content/patterns/medical-diagnosis/_index.adoc @@ -1,7 +1,7 @@ --- title: Medical Diagnosis date: 2021-01-19 -tier: maintained +tier: archived summary: This pattern is based on a demo implementation of an automated data pipeline for chest X-ray analysis previously developed by Red Hat. rh_products: - Red Hat OpenShift Container Platform @@ -22,7 +22,6 @@ links: arch: https://www.redhat.com/architect/portfolio/detail/6-enabling-medical-imaging-diagnostics-with-edge bugs: https://github.com/validatedpatterns/medical-diagnosis/issues feedback: https://docs.google.com/forms/d/e/1FAIpQLScI76b6tD1WyPu2-d_9CCVDr3Fu5jYERthqLKJDUGwqBg7Vcg/viewform -ci: medicaldiag --- include::modules/comm-attributes.adoc[] :_content-type: ASSEMBLY diff --git a/content/workshop/tiers.adoc b/content/workshop/tiers.adoc index 9b80ca8598..0a15e782c8 100644 --- a/content/workshop/tiers.adoc +++ b/content/workshop/tiers.adoc @@ -32,6 +32,12 @@ a| * functional on all currently supported/extended update support (EUS) version * must document their support policy | link:/contribute/maintained/[Details] +|**Archived** +a| * pattern repository has been archived on GitHub + * the pattern is no longer under active development or maintenance + * documentation remains available for reference +| link:/contribute/archived/[Details] + |=== == Additional Resources diff --git a/layouts/index.html b/layouts/index.html index 6124f21a8d..0f3b6d1ba7 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -142,11 +142,6 @@

→ MLOps fraud detection -
- - → Medical diagnosis - -
diff --git a/layouts/partials/archived-banner.html b/layouts/partials/archived-banner.html new file mode 100644 index 0000000000..68e173cc69 --- /dev/null +++ b/layouts/partials/archived-banner.html @@ -0,0 +1,23 @@ +{{/* + Banner shown on all pages belonging to an archived pattern. +*/}} +{{ $tier := "" }} +{{ if isset .Params "tier" }} + {{ $tier = .Params.tier }} +{{ else if and .CurrentSection (isset .CurrentSection.Params "tier") }} + {{ $tier = .CurrentSection.Params.tier }} +{{ end }} +{{ if eq $tier "archived" }} +
+
+ + Archived + + + This pattern is archived. The source repository is no longer maintained, + and Validated Patterns maintainers do not recommend deploying it for new use cases. + Documentation remains available for reference. + +
+
+{{ end }} diff --git a/layouts/partials/label-archived.html b/layouts/partials/label-archived.html new file mode 100644 index 0000000000..ba64b6beaa --- /dev/null +++ b/layouts/partials/label-archived.html @@ -0,0 +1,6 @@ + + + Archived + Archived + + diff --git a/layouts/partials/links.html b/layouts/partials/links.html index 92a8682b1d..7525062a24 100644 --- a/layouts/partials/links.html +++ b/layouts/partials/links.html @@ -14,7 +14,11 @@ + {{ if eq (.Param "tier") "archived" }} + Install + {{ else }} Install + {{ end }} {{ end }} {{ if (isset .Params.links "arch") }} diff --git a/layouts/partials/patterns-index.html b/layouts/partials/patterns-index.html index ad8e0fde53..5903cc2c34 100644 --- a/layouts/partials/patterns-index.html +++ b/layouts/partials/patterns-index.html @@ -44,7 +44,14 @@ {{ partial "page-toolbar.html" . }}
{{ partial "toc.html" . }} -
+ {{ $archivedTier := "" }} + {{ if isset .Params "tier" }} + {{ $archivedTier = .Params.tier }} + {{ else if and .CurrentSection (isset .CurrentSection.Params "tier") }} + {{ $archivedTier = .CurrentSection.Params.tier }} + {{ end }} +
+ {{ partial "archived-banner.html" . }}
@@ -82,12 +89,14 @@

{{ .Title }}

{{ partial "label-maintained.html" . }} {{ else if (eq $validated "tested" ) }} {{ partial "label-tested.html" . }} + {{ else if (eq $validated "archived" ) }} + {{ partial "label-archived.html" . }} {{ else }} {{ partial "label-sandbox.html" . }} {{ end }}
- {{ if (isset .Params "ci") }} + {{ if and (isset .Params "ci") (ne (.Param "tier") "archived") }}
{{ partial "ci.html" . }}
diff --git a/layouts/patterns/list.json.json b/layouts/patterns/list.json.json index c7d1672242..7179a76081 100644 --- a/layouts/patterns/list.json.json +++ b/layouts/patterns/list.json.json @@ -48,7 +48,8 @@ {{- $tiers_list := slice -}} {{- $tiers_list = $tiers_list | append (dict "Name" "maintained" "LinkTitle" "Maintained" "color" "green") }} {{- $tiers_list = $tiers_list | append (dict "Name" "tested" "LinkTitle" "Tested" "color" "blue") }} - {{- $tiers_list = $tiers_list | append (dict "Name" "sandbox" "LinkTitle" "Sandbox" "color" "oragne") }} + {{- $tiers_list = $tiers_list | append (dict "Name" "sandbox" "LinkTitle" "Sandbox" "color" "orange") }} + {{- $tiers_list = $tiers_list | append (dict "Name" "archived" "LinkTitle" "Archived" "color" "grey") }} {{- $tiers_filter_types := slice "OR" }} {{- $tiers_dict := dict "filter_list" $tiers_list "filter_types" $tiers_filter_types }} diff --git a/layouts/patterns/single.html b/layouts/patterns/single.html index 8674c53c29..60cf411e4b 100644 --- a/layouts/patterns/single.html +++ b/layouts/patterns/single.html @@ -11,7 +11,14 @@ {{ partial "page-toolbar.html" . }}
{{ partial "toc.html" . }} -
+ {{ $archivedTier := "" }} + {{ if isset .Params "tier" }} + {{ $archivedTier = .Params.tier }} + {{ else if and .CurrentSection (isset .CurrentSection.Params "tier") }} + {{ $archivedTier = .CurrentSection.Params.tier }} + {{ end }} +
+ {{ partial "archived-banner.html" . }} {{ .Content }} diff --git a/layouts/patterns/summary-with-image.html b/layouts/patterns/summary-with-image.html index 1284fde395..92a18b926c 100644 --- a/layouts/patterns/summary-with-image.html +++ b/layouts/patterns/summary-with-image.html @@ -1,5 +1,10 @@ {{ $featured_image := partial "func/GetFeaturedImage.html" . }} -
+{{ $validated := .Param "tier" }} +{{ $cardClass := "pf-c-card" }} +{{ if eq $validated "archived" }} + {{ $cardClass = "pf-c-card pattern-card-archived" }} +{{ end }} +
{{ .Title }} @@ -15,11 +20,12 @@ {{ .Summary }}
- {{ $validated := .Param "tier" }} {{ if (eq $validated "maintained" ) }} {{ partial "label-maintained.html" . }} {{ else if (eq $validated "tested" ) }} {{ partial "label-tested.html" . }} + {{ else if (eq $validated "archived" ) }} + {{ partial "label-archived.html" . }} {{ else }} {{ partial "label-sandbox.html" . }} {{ end }} diff --git a/modules/comm-attributes.adoc b/modules/comm-attributes.adoc index 1877d26378..7cb41ae3e2 100644 --- a/modules/comm-attributes.adoc +++ b/modules/comm-attributes.adoc @@ -13,10 +13,12 @@ :sandbox: sandbox :maintained: maintained :tested: tested +:archived: archived :validated: validated :sandbox-tier-first: Validated Patterns Sandbox tier :tested-tier-first: Validated Patterns Tested tier :maintained-tier-first: Validated Patterns Maintained tier +:archived-tier-first: Validated Patterns Archived tier //:solution-version: Update later when we start using versioned releases //Patterns :aeg-pattern: Ansible Edge GitOps pattern diff --git a/modules/medical-diagnosis/metadata-medical-diagnosis.adoc b/modules/medical-diagnosis/metadata-medical-diagnosis.adoc index 22677231f0..c852c4249b 100644 --- a/modules/medical-diagnosis/metadata-medical-diagnosis.adoc +++ b/modules/medical-diagnosis/metadata-medical-diagnosis.adoc @@ -9,7 +9,7 @@ :issues_url: https://github.com/validatedpatterns/medical-diagnosis/issues :docs_url: https://validatedpatterns.io/patterns/medical-diagnosis/ :ci_url: https://validatedpatterns.io/ci/?pattern=medicaldiag -:tier: maintained +:tier: archived :owners: day0hero :requirements_hub_compute_platform_gcp_replicas: 5 :requirements_hub_compute_platform_gcp_type: n1-standard-16 diff --git a/static/css/custom.css b/static/css/custom.css index d23109f4fe..d6f2f96ffa 100644 --- a/static/css/custom.css +++ b/static/css/custom.css @@ -3637,3 +3637,104 @@ a.ci-status-unavailable-link:hover { background-position: -160% 0; } } + +/* Archived pattern cards and page banner */ +.pattern-card-archived { + filter: grayscale(1); + opacity: 0.8; + background-color: var(--pf-global--BackgroundColor--200); +} + +.pattern-card-archived .pf-c-card__title a { + color: var(--pf-global--Color--200); +} + +/* Grey label for Archived tier (not present in this PatternFly build) */ +.pf-c-label.pf-m-grey { + --pf-c-label--BackgroundColor: var(--pf-global--palette--black-200); + --pf-c-label__icon--Color: var(--pf-global--Color--dark-200); + --pf-c-label__content--Color: var(--pf-global--Color--dark-100); + --pf-c-label__content--before--BorderWidth: 0; + --pf-c-label__content--before--BorderColor: transparent; +} + +.pf-c-label.pf-m-grey .pf-c-label__content::before { + border: 0; + display: none; +} + +.archived-pattern-banner { + position: sticky; + top: 0; + z-index: var(--pf-global--ZIndex--md); + margin-bottom: var(--pf-global--spacer--md); + background-color: var(--pf-global--palette--black-150); + color: var(--pf-global--Color--dark-100); + border-left: 4px solid var(--pf-global--palette--black-500); + border-radius: var(--pf-global--BorderRadius--sm); + box-shadow: var(--pf-global--BoxShadow--md-bottom); + padding: var(--pf-global--spacer--md); +} + +.archived-pattern-banner__inner { + display: flex; + align-items: flex-start; + gap: var(--pf-global--spacer--md); + flex-wrap: wrap; +} + +.archived-pattern-banner__label { + flex: 0 0 auto; +} + +.archived-pattern-banner__text { + flex: 1 1 16rem; + color: var(--pf-global--Color--dark-100); + white-space: normal; + line-height: var(--pf-global--LineHeight--md); +} + +/* Desaturate archived pattern page content; keep banner readable */ +.pattern-page-archived { + color: var(--pf-global--Color--200); +} + +.pattern-page-archived h1, +.pattern-page-archived h2, +.pattern-page-archived h3, +.pattern-page-archived h4, +.pattern-page-archived h5, +.pattern-page-archived h6, +.pattern-page-archived .pf-c-title, +.pattern-page-archived p, +.pattern-page-archived li, +.pattern-page-archived td, +.pattern-page-archived th, +.pattern-page-archived dt, +.pattern-page-archived dd { + color: var(--pf-global--Color--200); +} + +.pattern-page-archived a { + color: var(--pf-global--link--Color); + opacity: 0.75; +} + +.pattern-page-archived img, +.pattern-page-archived svg, +.pattern-page-archived video, +.pattern-page-archived .pattern_logo { + filter: grayscale(1); + opacity: 0.85; +} + +.pattern-page-archived .archived-pattern-banner, +.pattern-page-archived .archived-pattern-banner * { + color: var(--pf-global--Color--dark-100); + opacity: 1; + filter: none; +} + +.pattern-page-archived .archived-pattern-banner__text { + color: var(--pf-global--Color--dark-100); +} diff --git a/static/images/pattern-tier-archived.png b/static/images/pattern-tier-archived.png new file mode 100644 index 0000000000..7aac327407 Binary files /dev/null and b/static/images/pattern-tier-archived.png differ diff --git a/static/js/dashboard.v2.js b/static/js/dashboard.v2.js index 6da5d5c7fd..4fb19bb7ea 100644 --- a/static/js/dashboard.v2.js +++ b/static/js/dashboard.v2.js @@ -88,6 +88,12 @@ function jira_component (pattern) { return pattern } +// CI pattern keys for patterns in the Archived tier. Keep in sync with +// content/patterns/**/_index.* where tier: archived. +var ARCHIVED_CI_PATTERNS = { + medicaldiag: true +} + // First segment of badge filenames (before the first `-`) → Hugo section under /patterns/, or absolute path. // Sync new keys with `ci:` in content/patterns/**/_index.* (hyphenated CI IDs often appear only as a shortened prefix in keys). var CI_PATTERN_DOC_SLUG = { @@ -1367,8 +1373,15 @@ function getBadges (xmlText, bucket_url, badge_set) { return badges } +function excludeArchivedPatternsFromDashboard (badges) { + return badges.filter(function (badge) { + return !ARCHIVED_CI_PATTERNS[badge.pattern] + }) +} + function processBadges (badges, options) { badges = excludeRetiredOcpVersionsFromDashboard(badges) + badges = excludeArchivedPatternsFromDashboard(badges) if (options.get('disable_buttons') === true) { processBadgesLegacy(badges, options) return diff --git a/static/js/patterns-browser-v2.js b/static/js/patterns-browser-v2.js index 38fc7a83cf..0c73cb2a0e 100644 --- a/static/js/patterns-browser-v2.js +++ b/static/js/patterns-browser-v2.js @@ -72,7 +72,14 @@ class FilteredPatterns { patternPassed = false; }; }; - if (patternPassed == true) { filteredPatterns.push(this.patterns[item]); }; + // Hide archived patterns unless the Archived tier filter is selected. + var patternTier = (this.patterns[item].Params.tier || "").toLowerCase(); + var isArchived = patternTier === "archived"; + var tierFilters = this.patterns_filter.filter_values.tier || []; + var archivedSelected = tierFilters.some(t => t.toLowerCase() === "archived"); + if (patternPassed == true && !(isArchived && !archivedSelected)) { + filteredPatterns.push(this.patterns[item]); + }; }; // This is a special filter for the variant parent. If variant_of is set, @@ -409,7 +416,8 @@ function selectFocusAreaChip(focusAreaName) { function renderLabel(tier, tier_categories) { // HTML to render the pattern tier label if (tier != undefined) { - var color= tier_categories.filter_list.find(item => item.Name === tier); + var colorItem = tier_categories.filter_list.find(item => item.Name === tier); + var color = colorItem ? colorItem.color : "grey"; var renderedLabelHtml = (` ${capitalizeFirstLetter(tier)} @@ -425,8 +433,10 @@ function renderLabel(tier, tier_categories) { function renderCard(pattern, tier_categories, variant_count) { // HTML for each pattern card var pattern_id = pattern.Link.split("/").filter(n => n)[1]; + var isArchived = (pattern.Params.tier || "").toLowerCase() === "archived"; + var cardClass = isArchived ? "pf-c-card pattern-card-archived" : "pf-c-card"; var renderCardHtml = (`
-
+
${pattern.Name}