Skip to content

Commit bdd1534

Browse files
authored
chore(docs): update integrations links and code blocks (#199)
Signed-off-by: Miguel Martinez Trivino <miguel@chainloop.dev>
1 parent 98e3c5c commit bdd1534

2 files changed

Lines changed: 15 additions & 15 deletions

File tree

app/controlplane/plugins/sdk/readme-generator/main.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ func updateIntegrationsIndex(plugins sdk.AvailablePlugins) error {
8888
}
8989

9090
// We need to full URL path because we render this file in the website
91-
const repoBase = "https://github.com/chainloop-dev/chainloop/blob/main/app/controlplane/plugins/core"
92-
pathToPlugin := filepath.Join(repoBase, p.Describe().ID, "v1", "README.md")
91+
const repoBase = "https://github.com/chainloop-dev/chainloop/tree/main/app/controlplane/plugins/core"
92+
pathToPlugin := filepath.Join(repoBase, p.Describe().ID, "v1")
9393

9494
indexTable += fmt.Sprintf("| [%s](%s) | %s | %s | %s |\n", info.ID, pathToPlugin, info.Version, info.Description, strings.Join(subscribedMaterials, ", "))
9595
}

docs/integrations.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@
22

33
Operators can extend Chainloop functionality by setting up third-party integrations that operate on your attestation metadata. Integrations can range from sending a Slack message, uploading the attestation to a storage backend or sending a Software Bill Of Materials (SBOMs) to a third-party service for analysis, for example.
44

5-
Below you can find the list of currently available integrations. If you can't find the integration you are looking for, feel free [to reach out](https://github.com/chainloop-dev/chainloop/issues) or [contribute your own](https://github.com/chainloop-dev/chainloop/blob/main/app/controlplane/plugins/README.md)!
6-
75
![FanOut Plugin](./img/fanout.png)
86

7+
Below you can find the list of currently available integrations. If you can't find the integration you are looking for, feel free [to reach out](https://github.com/chainloop-dev/chainloop/issues) or [contribute your own](https://github.com/chainloop-dev/chainloop/blob/main/app/controlplane/plugins/README.md)!
8+
99
## Available Integrations
1010

1111
| ID | Version | Description | Material Requirement |
1212
| --- | --- | --- | --- |
13-
| [dependency-track](https:/github.com/chainloop-dev/chainloop/blob/main/app/controlplane/plugins/core/dependency-track/v1/README.md) | 1.2 | Send CycloneDX SBOMs to your Dependency-Track instance | SBOM_CYCLONEDX_JSON |
14-
| [smtp](https:/github.com/chainloop-dev/chainloop/blob/main/app/controlplane/plugins/core/smtp/v1/README.md) | 1.0 | Send emails with information about a received attestation | |
15-
| [oci-registry](https:/github.com/chainloop-dev/chainloop/blob/main/app/controlplane/plugins/core/oci-registry/v1/README.md) | 1.0 | Send attestations to a compatible OCI registry | |
16-
| [discord-webhook](https:/github.com/chainloop-dev/chainloop/blob/main/app/controlplane/plugins/core/discord-webhook/v1/README.md) | 1.1 | Send attestations to Discord | |
13+
| [dependency-track](https:/github.com/chainloop-dev/chainloop/tree/main/app/controlplane/plugins/core/dependency-track/v1) | 1.2 | Send CycloneDX SBOMs to your Dependency-Track instance | SBOM_CYCLONEDX_JSON |
14+
| [smtp](https:/github.com/chainloop-dev/chainloop/tree/main/app/controlplane/plugins/core/smtp/v1) | 1.0 | Send emails with information about a received attestation | |
15+
| [oci-registry](https:/github.com/chainloop-dev/chainloop/tree/main/app/controlplane/plugins/core/oci-registry/v1) | 1.0 | Send attestations to a compatible OCI registry | |
16+
| [discord-webhook](https:/github.com/chainloop-dev/chainloop/tree/main/app/controlplane/plugins/core/discord-webhook/v1) | 1.1 | Send attestations to Discord | |
1717

1818
## How to use integrations
1919

2020
First, you need to make sure that the integration that you are looking for is available in your Chainloop instance, to do so you will:
2121

22-
```console
22+
```sh
2323
$ chainloop integration available list
2424
┌──────────────────┬─────────┬──────────────────────┬───────────────────────────────────────────────────────────┐
2525
│ ID │ VERSION │ MATERIAL REQUIREMENT │ DESCRIPTION │
@@ -36,16 +36,16 @@ $ chainloop integration available list
3636

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

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

41-
### Registering an extension
41+
### Registering an integration
4242

4343
Registration is when a specific instance of the integration is configured on a Chainloop organization. A registered instance is then available to be attached to any workflow.
4444

4545
In our case, we want to register an instance of the `oci-registry` integration. To do so, we need to first figure out what configuration parameters are required by the integration. We can do so by running:
4646

47-
```console
48-
chainloop integration available describe --id oci-registry
47+
```sh
48+
$ chainloop integration available describe --id oci-registry
4949
┌──────────────┬─────────┬──────────────────────┬────────────────────────────────────────────────┐
5050
│ ID │ VERSION │ MATERIAL REQUIREMENT │ DESCRIPTION │
5151
├──────────────┼─────────┼──────────────────────┼────────────────────────────────────────────────┤
@@ -71,7 +71,7 @@ chainloop integration available describe --id oci-registry
7171

7272
In the console output we can see a registration section that indicates that 3 parameters are required, let's go ahead and register it using our Google Artifact Registry Credentials by running:
7373

74-
```console
74+
```sh
7575
$ chainloop integration registered add oci-registry \
7676
# i.e us-east1-docker.pkg.dev/my-project/chainloop-cas-devel
7777
--opt repository=[region]-docker.pkg.dev/[my-project]/[my-repository] \
@@ -81,7 +81,7 @@ $ chainloop integration registered add oci-registry \
8181

8282
> Note: You can find more examples on how to configure this specific integration [here](https://github.com/chainloop-dev/chainloop/tree/main/app/controlplane/plugins/core/oci-registry/v1)
8383
84-
### Attaching an extension
84+
### Attaching an integration
8585

8686
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.
8787

0 commit comments

Comments
 (0)