-
Notifications
You must be signed in to change notification settings - Fork 71
WIP: Added archived tier #714
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.
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
gaurav-nelson
wants to merge
1
commit into
validatedpatterns:main
Choose a base branch
from
gaurav-nelson:archived-tier-MBP1157
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" }} | ||
| <div class="archived-pattern-banner" role="status"> | ||
| <div class="archived-pattern-banner__inner"> | ||
| <span class="pf-c-label pf-m-grey archived-pattern-banner__label"> | ||
| <span class="pf-c-label__content">Archived</span> | ||
| </span> | ||
| <span class="archived-pattern-banner__text"> | ||
| 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. | ||
| </span> | ||
| </div> | ||
| </div> | ||
| {{ end }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <span class="pf-c-label pf-m-grey"> | ||
| <span class="pf-c-label__content"> | ||
| <img src="/images/pattern-tier-archived.png" alt="Archived" width="16" height="16" class="custom-pattern-icon"/> | ||
| Archived | ||
| </span> | ||
| </span> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.