diff --git a/content/contribute/creating-a-pattern.adoc b/content/contribute/creating-a-pattern.adoc index 396aea7f8..0a1be9aa0 100644 --- a/content/contribute/creating-a-pattern.adoc +++ b/content/contribute/creating-a-pattern.adoc @@ -32,7 +32,7 @@ Therefore the question really is: How do I move my successful architecture solut == Requirements for creating a new pattern -* The recommended way to create a new pattern is to use link:/learn/creating-patterns-with-patternizer/[patternizer], which generates all required scaffolding automatically. Alternatively, fork the link:/patterns/multicloud-gitops[multicloud-gitops pattern] as a starting point. +* The recommended way to create a new pattern is to use link:/learn/creating-patterns-with-patternizer/[patternizer], which generates all required scaffolding automatically. Alternatively, fork the link:/patterns/multicloud-gitops[{mcg-pattern}] as a starting point. * The patterns framework requires OpenShift GitOps (ArgoCD) to provide the GitOps automation. Patternizer sets this up for you; if starting from a fork, ensure OpenShift GitOps is included. * Create a new branch on your new pattern to perform the initial changes. * Deploy the initial new pattern to the cluster. diff --git a/content/learn/creating-patterns-with-patternizer.adoc b/content/learn/creating-patterns-with-patternizer.adoc index cb8e03474..811ad0d1f 100644 --- a/content/learn/creating-patterns-with-patternizer.adoc +++ b/content/learn/creating-patterns-with-patternizer.adoc @@ -127,7 +127,7 @@ clusterGroup: chartVersion: 0.1.* ---- -If you omit `--with-secrets`, the generated files will not include the Vault and External Secrets Operator configuration, and `secretLoader.disabled` will be set to `true` in `values-global.yaml`. +If you omit `--with-secrets`, the generated files do not include the Vault and External Secrets Operator configuration, and patternizer sets `secretLoader.disabled` to `true` in `values-global.yaml`. === Step 3: Define your pattern content @@ -135,9 +135,9 @@ After initialization, you need to add your operators, applications, and Helm cha ==== Using the pattern-author AI coding skill -Patternizer installs an AI coding skill to `.claude/skills/pattern-author/` and `.cursor/skills/pattern-author/` during initialization. This skill teaches AI coding assistants such as Claude Code and Cursor how to author Validated Patterns -- defining namespaces, operators, applications, secrets, hub/spoke clusters, and more. +Patternizer installs an AI coding skill to `.claude/skills/pattern-author/` and `.cursor/skills/pattern-author/` during initialization. This skill provides guidance for AI coding assistants such as Claude Code and Cursor to author Validated Patterns -- defining namespaces, operators, applications, secrets, hub/spoke clusters, and more. -Open the initialized repository in your AI-assisted editor and the skill will be available automatically. You can ask the assistant to add operators, wire in Helm charts, configure secrets, or set up multi-cluster deployments. +Open the initialized repository in your AI-assisted editor and the skill is available automatically. You can ask the assistant to add operators, wire in Helm charts, configure secrets, or set up multi-cluster deployments. ==== Manually editing values files @@ -153,7 +153,7 @@ For detailed guidance on structuring your pattern, see link:/learn/vp_structure_ [NOTE] .Idempotency ==== -The `pattern init` command is idempotent and can be run multiple times during pattern creation to update the pattern values files. You can go from `pattern init` to `pattern init --with-secrets` to add the secrets framework to your pattern. If you use `helm create` (or `./pattern.sh helm create`) to create Helm charts and then run `pattern init` again, the Helm charts will be automatically added to your `values-prod.yaml`. +The `pattern init` command is idempotent and can be run multiple times during pattern creation to update the pattern values files. You can go from `pattern init` to `pattern init --with-secrets` to add the secrets framework to your pattern. If you use `helm create` (or `./pattern.sh helm create`) to create Helm charts and then run `pattern init` again, patternizer automatically adds the Helm charts to your `values-prod.yaml`. ==== === Next steps diff --git a/content/learn/getting-started-multi-cloud-gitops.adoc b/content/learn/getting-started-multi-cloud-gitops.adoc index 197d9c84c..863b5f6ff 100644 --- a/content/learn/getting-started-multi-cloud-gitops.adoc +++ b/content/learn/getting-started-multi-cloud-gitops.adoc @@ -23,10 +23,10 @@ Multicloud GitOps is a foundational pattern that demonstrates the core concepts Deploying Multicloud GitOps gives you hands-on experience with: -. How operators and applications are defined in values files -. How ArgoCD manages application lifecycle -. How secrets are loaded and managed -. How the pattern framework ties everything together +* How operators and applications are defined in values files +* How ArgoCD manages application lifecycle +* How secrets are loaded and managed +* How the pattern framework ties everything together == Deploying the Multicloud GitOps pattern diff --git a/content/learn/quickstart.adoc b/content/learn/quickstart.adoc index 9d3deee59..9330b0038 100644 --- a/content/learn/quickstart.adoc +++ b/content/learn/quickstart.adoc @@ -20,7 +20,7 @@ Validated Patterns can be deployed using either the OpenShift-based Validated Pa == Getting Started with Validated Patterns -=== What You'll Learn +=== What you will learn . Setting up prerequisites for Validated Patterns . Creating a new pattern with patternizer diff --git a/content/learn/vp_structure_vp_pattern.adoc b/content/learn/vp_structure_vp_pattern.adoc index 92fcd7272..d21c255d6 100644 --- a/content/learn/vp_structure_vp_pattern.adoc +++ b/content/learn/vp_structure_vp_pattern.adoc @@ -14,7 +14,7 @@ include::modules/comm-attributes.adoc[] == Creating a validated pattern -The high level steps to create a validated pattern are as follows: +The high level steps to create a validated pattern are as follows: 1. Identify the business case you want to address. 2. Use link:/learn/creating-patterns-with-patternizer/[patternizer] to bootstrap a new pattern repository with all required scaffolding, or fork an existing pattern such as link:/patterns/multicloud-gitops[Multicloud GitOps] to start from a working example.