Skip to content

docs(integrations): fix typos #200

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 21, 2023
Merged

docs(integrations): fix typos #200

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/integrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ $ chainloop integration available list

Once you find your integration, i.e `oci-registry`, it's time to configure it.

Configuring a integration has two steps: 1) register it in your organization and 2) attach the registered integration to your workflows.
Configuring an integration has two steps: 1) register it in your organization and 2) attach the registered integration to your workflows.

### Registering an integration

Expand Down Expand Up @@ -83,15 +83,15 @@ $ chainloop integration registered add oci-registry \

### Attaching an integration

Once the integration is registered, we can attach it to any workflow. In practice this means that attestations and material information received by this workflow will be sent to the registered integration.
Once the integration is registered, we can attach it to any workflow. In practice this means that attestations and material information generated in this workflow will be sent to the registered integration.

The attachment process has at least two required parameters, the `workflowID` and the registered `integrationID`. Additionally each integration might have additional to customize its behavior per-workflow. In our case, on the table above, we can see that the `oci-registry` integration has an optional parameter called `prefix` that allows you to customize the name of the image that will be pushed to the registry.

```console
$ chainloop integration attached add --workflow $WID --integration $IID --opt prefix=custom-prefix
```

Congratulations, you are done now! Any attestation or material information received by the workflow will be sent to the registered integration.
Congratulations, you are done now! Every new attestation from this workflow will be uploaded to your OCI registry!

## FAQ

Expand Down