Skip to content

Commit

Permalink
more unification of usage sections
Browse files Browse the repository at this point in the history
  • Loading branch information
casperdcl committed Oct 12, 2021
1 parent 4a9f4d9 commit 41f4c88
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions content/docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ jobs:
cml send-comment report.md
```
The example above generates visual reports in a pull request:
[![](/img/cml_first_report.png)](https://github.com/iterative/cml_base_case/pull/2)
We helpfully provide CML and other useful libraries pre-installed on our
[custom Docker images](/doc/self-hosted-runners#docker-images). In the above
example, uncommenting the
Expand Down Expand Up @@ -81,9 +84,9 @@ create-CML-report:
- cml send-comment report.md
```

⚠️ You _must_ create
⚠️ You _must_ provide a
[personal or project access token (PAT)](/doc/self-hosted-runners#personal-access-token)
and save it in a `repo_token` variable.
via a `repo_token` variable.

The example above generates visual reports in a merge request:
[![](/img/GitLab_CML_report.png '=400')](https://gitlab.com/iterative.ai/cml-base-case/-/merge_requests/3)
Expand Down Expand Up @@ -126,13 +129,13 @@ pipelines:
- cml send-comment report.md
```

The example above generates visual reports in a pull request:
[![](/img/bitbucket_cloud_pr.png '=600')](https://bitbucket.org/iterative-ai/cml-base-case/pull-requests/2)

⚠️ You _must_ provide
[access credentials](/doc/self-hosted-runners#personal-access-token) via a
`repo_token` variable.

The example above generates visual reports in a pull request:
[![](/img/bitbucket_cloud_pr.png '=600')](https://bitbucket.org/iterative-ai/cml-base-case/pull-requests/2)

⚠️ CML works with Bitbucket Cloud, where you can use the
[Bitbucket Pipelines](https://bitbucket.org/product/features/pipelines) CI/CD
system to run workflows automatically on triggering events. Bitbucket Server is
Expand Down

0 comments on commit 41f4c88

Please sign in to comment.