[TAAP-1056] edits PR pivotal#2267

kiwi-bui · Mar 20, 2023 · 427025d · 427025d
1 parent b384a0f
commit 427025d
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 36 deletions.
diff --git a/release-notes.hbs.md b/release-notes.hbs.md
@@ -66,7 +66,7 @@ This topic contains release notes for Tanzu Application Platform v1.5.
 
 #### <a id='1-5-0-scc-new-features'></a> Supply Chain Choreographer
 
-- Introduces ability to configure the OOTB Basic supply chain to [output Carvel Packages](scc/carvel-package-supply-chain.hbs.md). This feature is experimental.
+- Introduces a variation of the OOTB Basic supply chains that output Carvel packages. Carvel packages enable configuring for each runtime environment. See [Carvel Package Workflow](scc/carvel-package-supply-chain.hbs.md). This feature is experimental.
 
 #### <a id='1-5-0-scst-policy-new-features'></a> Supply Chain Security Tools - Policy Controller
 

diff --git a/scc/carvel-package-supply-chain.hbs.md b/scc/carvel-package-supply-chain.hbs.md
@@ -1,18 +1,23 @@
 # Carvel Package Workflow (Experimental)
 
-The [Out of the Box Basic Supply Chain](ootb-supply-chain-basic.hbs.md) package can be configured to output Carvel Packages to a GitOps repository. This feature is experimental and can be used alongside the existing Out of the Box Basic workflow.
+The [Out of the Box Basic Supply Chain](ootb-supply-chain-basic.hbs.md) package
+introduces a variation of the OOTB Basic supply chains that output Carvel
+Packages. Carvel packages enable configuring for each runtime environment. This
+feature is experimental and is used alongside the existing Out of the Box Basic
+workflow.
 
-This document provides instructions for both an operator and developer on make use of the Carvel Package workflow.
+This experimental feature has the following limits:
 
-Note that as this feature is experimental, there are some limitations:
 1. Only the [Out of the Box Basic Supply Chain](ootb-supply-chain-basic.hbs.md) package is supported. The Testing and Scanning supply chains are not supported.
 2. Only workloads of type `server` are supported.
 
 ## How To: Operator
 
+This section describes operator tasks for installing Carvel package.
+
 ### Prerequisites
 
-- You will need access to a GitOps repository and credentials, as described in [GitOps versus RegistryOps](gitops-vs-regops.hbs.md#gitops).
+To install Carvel package, you need access to a GitOps repository and credentials. See [GitOps versus RegistryOps](gitops-vs-regops.hbs.md#gitops).
 
 ### Installation
 
@@ -26,7 +31,7 @@ In `tap-values`, configure the [Out of the Box Basic Supply Chain](ootb-supply-c
         workflow_enabled: true
     ```
 
-2. (Optional) Set a GitOps subpath. This will determine the path in your GitOps repository to which Carvel Packages are written. See the [Carvel Package template](ootb-template-reference.hbs.md#carvel-package-experimental) for more information.
+2. (Optional) Set a GitOps subpath. This verifies the path in your GitOps repository to which Carvel Packages are written. See [Carvel Package template](ootb-template-reference.hbs.md#carvel-package-experimental).
 
     ```yaml
     ootb_supply_chain_basic:
@@ -35,7 +40,7 @@ In `tap-values`, configure the [Out of the Box Basic Supply Chain](ootb-supply-c
         gitops_subpath: path/to/my/dir
     ```
 
-3. (Optional) Set a name suffix. This will determine the suffix of the name of the Carvel Package. See the [Carvel Package template](ootb-template-reference.hbs.md#carvel-package-experimental) for more information.
+3. (Optional) Set a name suffix. This verifies the suffix of the name of the Carvel Package. See [Carvel Package template](ootb-template-reference.hbs.md#carvel-package-experimental).
 
     ```yaml
     ootb_supply_chain_basic:
@@ -45,20 +50,23 @@ In `tap-values`, configure the [Out of the Box Basic Supply Chain](ootb-supply-c
         name_suffix: vmware.com
     ```
 
-Then, in `tap-values`, configure the [Out of the Box Basic Supply Chain](ootb-supply-chain-basic.hbs.md) package with your GitOps parameters, as described in [GitOps versus RegistryOps](gitops-vs-regops.hbs.md#gitops).
+4. In `tap-values`, configure the [Out of the Box Basic Supply Chain](ootb-supply-chain-basic.hbs.md) package with your GitOps parameters, as described in [GitOps versus RegistryOps](gitops-vs-regops.hbs.md#gitops).
 
-Finally, install the [Out of the Box Basic Supply Chain](ootb-supply-chain-basic.hbs.md) package.
+5. Install the [Out of the Box Basic Supply Chain](ootb-supply-chain-basic.hbs.md) package.
 
 ## How To: Developer
 
+This section describes developer tasks for installing Carvel package.
+
 ### Prerequisites
 
-- Your operator will need to enable the Carvel Package workflow for the [Out of the Box Basic Supply Chain](ootb-supply-chain-basic.hbs.md) package, as described above.
+To install Carvel package, your operator must enable the Carvel Package workflow for the [Out of the Box Basic Supply Chain](ootb-supply-chain-basic.hbs.md) package.
 
 ### Creating a Workload
 
-To utilize the Carvel Package workflow, you must add the label `apps.tanzu.vmware.com/carvel-package-workflow=true` to your workload.
-With the `tanzu` CLI, you can do so by using the following flag:
+To use the Carvel Package workflow, you must add the label `apps.tanzu.vmware.com/carvel-package-workflow=true` to your workload.
+
+Use the following Tanzu CLI flag:
 
 - `--label apps.tanzu.vmware.com/carvel-package-workflow=true`
 
@@ -90,18 +98,18 @@ Expect to see the following output:
      12 + |  image: IMAGE
   ```
 
-You can override two parameters set by the operator:
+To override two parameters set by the operator:
 
-1. (Optional) Set a GitOps subpath. This will determine the path in your GitOps repository to which Carvel Packages are written. See the [Carvel Package template](ootb-template-reference.hbs.md#carvel-package-experimental) for more information.
+1. (Optional) Set a GitOps subpath. This verifies the path in your GitOps repository to which Carvel Packages are written. See [Carvel Package template](ootb-template-reference.hbs.md#carvel-package-experimental).
 
-Set this parameter by modifying `workload.spec.params.carvel_package_gitops_subpath`. With the `tanzu` CLI, you can do so by using the following flag:
+Set this parameter by modifying `workload.spec.params.carvel_package_gitops_subpath`. With the Tanzu CLI, you can do so by using the following flag:
 
-- `--param carvel_package_gitops_subpath=path/to/my/dir`
+   - `--param carvel_package_gitops_subpath=path/to/my/dir`
 
-1. (Optional) Set a name suffix. This will determine the suffix of the name of the Carvel Package. See the [Carvel Package template](ootb-template-reference.hbs.md#carvel-package-experimental) for more information.
+1. (Optional) Set a name suffix. This verifies the suffix of the name of the Carvel Package. See [Carvel Package template](ootb-template-reference.hbs.md#carvel-package-experimental).
 
-Set this parameter by modifying `workload.spec.params.carvel_package_name_suffix`. With the `tanzu` CLI, you can do so by using the following flag:
+Set this parameter by modifying `workload.spec.params.carvel_package_name_suffix`. With the Tanzu CLI, you can do so by using the following flag:
 
-- `--param carvel_package_name_suffix=vmware.com`
+   - `--param carvel_package_name_suffix=vmware.com`
 
->**Note** You can optionally override GitOps parameters as described in [GitOps versus RegistryOps](gitops-vs-regops.hbs.md#gitops).
+>**Note** (Optional) You can override GitOps parameters as described in [GitOps versus RegistryOps](gitops-vs-regops.hbs.md#gitops).
diff --git a/scc/git.hbs.md b/scc/git.hbs.md
@@ -1,12 +1,12 @@
 # Git
 
-The out of the box supply chains and delivery use Git in 3 ways:
+The out of the box supply chains and delivery use Git in three ways:
 
 - To fetch the developers source code, using the [template](ootb-template-reference.hbs.md#source-template).
-- To store complete Kubernetes configuration, the "write" side of gitops, use 
+- To store complete Kubernetes configuration, the write side of GitOps, using 
   [template 1](ootb-template-reference.hbs.md#config-writer-template), [template 2](ootb-template-reference.hbs.md#config-writer-and-pull-requester-template), [template 3 (experimental)](ootb-template-reference.hbs.md#package-config-writer-template-experimental), and [template 4 (experimental)](ootb-template-reference.hbs.md#package-config-writer-and-pull-requester-template-experimental).
-- To fetch stored Kubernetes configuration, the read side of gitops,
-  from either the same or a different Kubernetes cluster, use the
+- To fetch stored Kubernetes configuration, the read side of GitOps,
+  from either the same or a different Kubernetes cluster, using the
   [template](ootb-template-reference.hbs.md#delivery-source-template).
 
 ## Supported Git Repositories
@@ -18,9 +18,10 @@ Tanzu Application Platform supports two Git providers:
 
 ## Related Articles
 
-[Git Authentication](git-auth.hbs.md): walks through the objects, such as secrets and service accounts,
+[Git Authentication](git-auth.hbs.md) walks through the objects, such as secrets and service accounts,
 to create on cluster to allow supply chain Git operations to succeed.
 
-[GitOps versus RegistryOps](gitops-vs-regops.hbs.md): discusses the two methods of storing built Kubernetes
-configuration, either in a git repository or an image registry, and walks through the parameters that must
-be provided for each.
+[GitOps versus RegistryOps](gitops-vs-regops.hbs.md) discusses the two methods
+of storing built Kubernetes configuration, either in a Git repository or a
+container image registry, and walks through the parameters that must be provided
+for each.
diff --git a/scc/ootb-supply-chain-basic.hbs.md b/scc/ootb-supply-chain-basic.hbs.md
@@ -230,5 +230,5 @@ of the supply chains), see the following sections:
   different ways of propagating the deployment configuration through external
   systems (Git repositories and image registries).
 
-- [Carvel Package Workflow (experimental)](carvel-package-supply-chain.hbs.md), for more information
+- [Carvel Package Workflow](carvel-package-supply-chain.hbs.md), for information
   about how to configure workloads to output Carvel Packages for delivery through Git repositories.
diff --git a/scc/ootb-supply-chain-reference.hbs.md b/scc/ootb-supply-chain-reference.hbs.md
@@ -345,10 +345,10 @@ for information about setting tap-values at installation time.
 
 ### Purpose
 
-- Fetches application source code,
-- builds it into an image,
-- bundles the Kubernetes configuration necessary to deploy the application into a Carvel Package,
-- and commits that Package to a Git Repository.
+- Fetches application source code
+- builds it into an image
+- bundles the Kubernetes configuration necessary to deploy the application into a Carvel Package
+- commits that Package to a Git Repository
 
 ### Resources
 
@@ -425,9 +425,9 @@ for information about setting tap-values at installation time.
 
 ## Basic-Image-to-URL-Package (experimental)
 
-- Fetches a prebuilt image,
-- bundles the Kubernetes configuration necessary to deploy the application into a Carvel Package,
-- and commits that Package to a Git Repository.
+- Fetches a prebuilt image
+- bundles the Kubernetes configuration necessary to deploy the application into a Carvel Package
+- commits that Package to a Git Repository
 
 ### Resources