diff --git a/docs/dep/dep-002.md b/docs/dep/dep-002.md index 6a7915d7d..685185041 100644 --- a/docs/dep/dep-002.md +++ b/docs/dep/dep-002.md @@ -72,7 +72,8 @@ the folder. All the Tasks listed need to have a unique name and all their parameters need to be prefixed with the name of the Task. They should not have a namespace value set, we expect that to be set during the deployment of a pipeline. Each task -must also have a label with key `v1.smithy.smithy-security.com/component` and value one +must also have a label with key +`v1.smithy.smithy-security.com/component` and value one of the components listed previously. A pipeline kustomization is free to list an arbitrary amount of components. diff --git a/docs/designs/architecture.md b/docs/designs/architecture.md index bc259e043..9581830ae 100644 --- a/docs/designs/architecture.md +++ b/docs/designs/architecture.md @@ -21,8 +21,8 @@ Smithy has 3 types of components: Each Task must be labelled with the type of component that is packaged in the image it references. -The label must have the name `v1.smithy.smithy-security.com/component` and the value -must be one of: +The label must have the name +`v1.smithy.smithy-security.com/component` and the value must be one of: 1. consumer 2. producer diff --git a/docs/getting-started.md b/docs/getting-started.md index 4ac8e9a81..522b1d03f 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -74,7 +74,11 @@ This will take a while, so we invite you to go and grab a coffee! For example, we can deploy a pipeline for the `golang-project`. -You can do so by executing `./bin/cmd/path/to/smithyctl ./examples/pipelines/golang-project`. +You can do so by executing `./bin/cmd/path/to/smithyctl pipelines deploy ./examples/pipelines/golang-project`. + +For example: + +`./bin/cmd/linux/amd64/smithyctl pipelines deploy ./examples/pipelines/golang-project`. ### Execute a pipeline