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

Update docs #439

Merged
merged 2 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/dep/dep-002.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/designs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down