Skip to content
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

New Validated Patterns tiers #352

Merged
merged 15 commits into from
Nov 20, 2023
Merged

Conversation

abhatt-rh
Copy link
Collaborator

@abhatt-rh abhatt-rh commented Oct 31, 2023

@mbaldessari
Copy link
Contributor

mbaldessari commented Oct 31, 2023

This is an automated message:

You can preview this docs PR at http://352.docs-pr.validatedpatterns.io
Note that they get generated every five minutes, so please wait a bit.

* A {tested} pattern must be meaningful without specialized hardware, including flavors of architectures not explicitly supported.
+
Qualification is a {solution-name-upstream} TOC decision with input from the pattern owner.
//AI: What's TOC?
Copy link
Collaborator

Choose a reason for hiding this comment

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

Technical Oversight Committee

//AI: What's TOC?
* 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.
* A {tested} pattern must include a standardized architecture drawing, created with (or at least conforming to) the PAC tooling
//AI: What's PAC
Copy link
Collaborator

Choose a reason for hiding this comment

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

Portfolio Architecture Council

Qualification is a {solution-name-upstream} TOC decision with input from the pattern owner.
//AI: What's TOC?
* 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.
* A {tested} pattern must include a standardized architecture drawing, created with (or at least conforming to) the PAC tooling
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* A {tested} pattern must include a standardized architecture drawing, created with (or at least conforming to) the PAC tooling
* A {tested} pattern must include a standardized architecture drawing, created with (or at least conforming to) the standard Patterns tooling

. Patterns must be useful without all content stored in private Git repositories.
. Patterns must include a list of names and versions of all the products and projects that the pattern consumes.
. Patterns must be useful without any sample applications that are private or that lack public sources.
//AI:why application was styled that way
Copy link
Collaborator

Choose a reason for hiding this comment

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

I was probably using it as a Noun elsewhere in the list

@abhatt-rh abhatt-rh force-pushed the pr-319 branch 3 times, most recently from 60420bf to 4cbcd96 Compare November 6, 2023 18:39
@beekhof
Copy link
Collaborator

beekhof commented Nov 8, 2023

/lgtm

Copy link
Contributor

openshift-ci bot commented Nov 15, 2023

New changes are detected. LGTM label has been removed.

@abhatt-rh abhatt-rh changed the title WIP: New Validated Patterns tiers New Validated Patterns tiers Nov 16, 2023
Copy link
Collaborator

@danmacpherson danmacpherson left a comment

Choose a reason for hiding this comment

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

Hi Avani,

Just found some minor issues. Overall, the content is great. Nice job!

content/learn/about-pattern-tiers-types.adoc Outdated Show resolved Hide resolved
content/learn/about-pattern-tiers-types.adoc Outdated Show resolved Hide resolved
content/learn/about-pattern-tiers-types.adoc Outdated Show resolved Hide resolved
content/learn/implementation.adoc Outdated Show resolved Hide resolved
content/learn/implementation.adoc Outdated Show resolved Hide resolved
Comment on lines 56 to 66
+
//TODO: Convert above link to adoc
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is the plus sign here necessary due to the next line being a comment?

content/learn/tested.adoc Show resolved Hide resolved
content/learn/tested.adoc Outdated Show resolved Hide resolved
content/learn/tested.adoc Outdated Show resolved Hide resolved
modules/edd-deploying-edd-pattern.adoc Show resolved Hide resolved
@abhatt-rh
Copy link
Collaborator Author

Ignoring the html test errors. These seem to for the renamed files and are sort of false positive. Raised an query with the htmltest repo. Not holding merge for this

Copy link
Collaborator Author

@abhatt-rh abhatt-rh left a comment

Choose a reason for hiding this comment

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

addresses all feedback

* A {maintained} pattern must be tested on all currently supported {rh-ocp} extended update support (EUS) releases.
* A {maintained} pattern must fix breakage in timely manner.
* A {maintained} pattern must document their support policy.
+
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, all the list continuation (+) here are required because they are a continuation on the support policy and statement.

content/learn/sandbox.adoc Outdated Show resolved Hide resolved
* 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.
+
The test plan must define how to validate if the pattern has been successfully deployed and is functionally operational.
Example: https://docs.google.com/document/d/12KQhdzjVIsxRURTnWAckiEMB3_96oWBjtlTXi1q73cg/view[Validating an Industrial Edge Deployment]
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No, we don't. It renders as interned since it's seen as ventilated prose

modules/edd-deploying-edd-pattern.adoc Show resolved Hide resolved
content/learn/implementation.adoc Outdated Show resolved Hide resolved
@abhatt-rh abhatt-rh merged commit d88ea3b into validatedpatterns:main Nov 20, 2023
5 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants