Skip to content

Commit d9de57a

Browse files
author
Kaspar Lyngsie
committed
chore: re-wrote some docs a bit, added other workflow mention
1 parent cbb7c13 commit d9de57a

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

help/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
# CLI Help files
22

3-
Snyk CLI Help files are managed by GitBook connected to the [snyk/user-docs](https://github.com/snyk/user-docs) repository.
3+
Snyk CLI Help files are managed by GitBook connected to the [snyk/user-docs](https://github.com/snyk/user-docs)
4+
repository.
45

5-
It's recommended to make all CLI Help changes there. Changes from GitBook are automatically [synced to the Snyk CLI repository with a GitHub Action](https://github.com/snyk/snyk/actions/workflows/sync-cli-help-to-user-docs.yml). The Action creates a PR that needs to be approved and merged. This Action could also be manually triggered.
6+
It's recommended to make all CLI Help changes there, as changes here will be overwritten by the next sync.
67

7-
If you need to make changes tied to a specific PR, you can make them in this repository first, merge the changes and then move them over to the GitBook.
8+
Changes from GitBook are automatically synced to the Snyk CLI repository with GitHub Actions:
9+
10+
- https://github.com/snyk/snyk/actions/workflows/sync-cli-help-to-user-docs.yml and
11+
- https://github.com/snyk/snyk/actions/workflows/sync-cli-readme.yml
12+
13+
The actions create PRs that need to be approved and merged. This action could also be manually triggered.
14+
15+
If you need to make changes tied to a specific PR, you can make them in this repository first, merge the changes and
16+
then move them over to the GitBook.
817

918
CLI help files are a standard Markdown.

0 commit comments

Comments
 (0)