Skip to content

Commit ca1b1f4

Browse files
authored
docs: update docs to reference name instead of id (#1059)
Signed-off-by: Miguel Martinez Trivino <[email protected]>
1 parent 3ea6c26 commit ca1b1f4

File tree

7 files changed

+10
-12
lines changed

7 files changed

+10
-12
lines changed

docs/docs/getting-started/workflow-definition.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ $ chainloop workflow create \
5555
By default, if no contract is provided, a new, empty one will be created
5656

5757
```bash
58-
$ chainloop workflow contract describe --id fd489047-67f1-45d4-9f3b-27eba4051929
58+
$ chainloop workflow contract describe --name build-and-test
5959
┌─────────────────────────────────────────────────────────────┐
6060
│ Contract │
6161
├──────────────────────┬──────────────────────────────────────┤
62-
│ Name │ build-and-test generated schema
62+
│ Name │ build-and-test
6363
├──────────────────────┼──────────────────────────────────────┤
6464
│ ID │ fd489047-67f1-45d4-9f3b-27eba4051929 │
6565
├──────────────────────┼──────────────────────────────────────┤
@@ -114,8 +114,7 @@ Update the name and schema, notice the revision increment
114114
115115
```bash
116116
$ chainloop workflow contract update \
117-
--id fd489047-67f1-45d4-9f3b-27eba4051929 \
118-
--name skynet-contract \
117+
--name build-and-test \
119118
-f https://raw.githubusercontent.com/chainloop-dev/chainloop/main/docs/examples/contracts/skynet/contract.yaml
120119

121120
┌─────────────────────────────────────────────────────────────┐

docs/docs/guides/dependency-track/dependency-track.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Using the [Chainloop CLI](/getting-started/installation), you can register an in
5858
This is done via the `chainloop integration registered add` command but first let's find out what are the required inputs using the `available describe` command.
5959

6060
```bash
61-
$ chainloop integration available describe --id dependency-track
61+
$ chainloop integration available describe --name dependency-track
6262

6363
┌──────────────────┬─────────┬──────────────────────┬────────────────────────────────────────────────────────┐
6464
│ ID │ VERSION │ MATERIAL REQUIREMENT │ DESCRIPTION │
@@ -104,7 +104,7 @@ The attachment is done via `chainloop integration attached add` command. But as
104104

105105

106106
```bash
107-
$ chainloop integration available describe --id dependency-track
107+
$ chainloop integration available describe --name dependency-track
108108

109109
┌──────────────────┬─────────┬──────────────────────┬────────────────────────────────────────────────────────┐
110110
│ ID │ VERSION │ MATERIAL REQUIREMENT │ DESCRIPTION │

docs/docs/guides/guac/guac.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Currently, this integration only supports [Google Cloud Storage](https://cloud.g
6363
To get started, you need to register the integration in your Chainloop organization. To know what parameters are accepted, you can use the `chainloop integration available describe` command.
6464

6565
```bash
66-
$ chainloop integration available describe --id guac
66+
$ chainloop integration available describe --name guac
6767
┌──────┬─────────┬─────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────┐
6868
│ ID │ VERSION │ MATERIAL REQUIREMENT │ DESCRIPTION │
6969
├──────┼─────────┼─────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────┤

docs/docs/guides/sbom-management/sbom-management.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export CONTRACT_ID=<your_contract_id>
5151

5252
Please check your contract to confirm that it is currently empty.
5353
```
54-
chainloop wf contract describe --id $CONTRACT_ID
54+
chainloop wf contract describe --name $CONTRACT_ID
5555
[...]
5656
{
5757
"schemaVersion": "v1"
@@ -66,7 +66,6 @@ We will add one requirement to our contract to ensure Developers provide a Cyclo
6666

6767
```bash
6868
chainloop workflow contract update \
69-
--id $CONTRACT_ID \
7069
--name my-contract \
7170
-f https://github.com/chainloop-dev/chainloop/blob/main/docs/examples/contracts/sbom/cyclonedx.yaml
7271
```

docs/docs/integrations/development/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ $ chainloop integration available list
6262
And the information of how to use it can be found in the describe command.
6363

6464
```console
65-
$ chainloop integration available describe --id dependencytrack
65+
$ chainloop integration available describe --name dependencytrack
6666
┌─────────────────┬─────────┬──────────────────────┬────────────────────────────────────────────────────────┐
6767
│ ID │ VERSION │ MATERIAL REQUIREMENT │ DESCRIPTION │
6868
├─────────────────┼─────────┼──────────────────────┼────────────────────────────────────────────────────────┤

docs/docs/integrations/integrations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Registration is when a specific instance of the integration is configured on a C
5151
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:
5252

5353
```sh
54-
$ chainloop integration available describe --id oci-registry
54+
$ chainloop integration available describe --name oci-registry
5555
┌──────────────┬─────────┬──────────────────────┬────────────────────────────────────────────────┐
5656
│ ID │ VERSION │ MATERIAL REQUIREMENT │ DESCRIPTION │
5757
├──────────────┼─────────┼──────────────────────┼────────────────────────────────────────────────┤

docs/docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ This quickstart will guide you through the process of installing the Chainloop C
8787
For example, to list the workflows you can run:
8888

8989
```bash
90-
# List workflow runs, so then you can do `workflow run describe --id <id>` to get more details
90+
# List workflow runs, so then you can do `workflow run describe --name <workflow-name>` to get more details
9191
chainloop workflow run ls
9292
```
9393

0 commit comments

Comments
 (0)