From 6d696415b81887dbe98b90691fd841f65504efd5 Mon Sep 17 00:00:00 2001 From: 7h3-3mp7y-m4n Date: Sun, 20 Oct 2024 03:09:56 +0530 Subject: [PATCH 1/3] Added oci example add the provisioner parameter in docs Signed-off-by: 7h3-3mp7y-m4n --- content/en/docs/score implementation/score-compose/cli.md | 2 +- content/en/docs/score implementation/score-k8s/cli.md | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/content/en/docs/score implementation/score-compose/cli.md b/content/en/docs/score implementation/score-compose/cli.md index b3f5437..91acd4f 100644 --- a/content/en/docs/score implementation/score-compose/cli.md +++ b/content/en/docs/score implementation/score-compose/cli.md @@ -49,7 +49,7 @@ score-compose init --project score-compose2 #### `--provisioners` | `-p` -Loads additional provisoners from a remote url. May be specified multiple times. Supports http://host/file, https://host/file, git-ssh://git@host/repo.git/file, and git-https://host/repo.git/file formats. +Loads additional provisoners from a remote url. May be specified multiple times. Supports http://host/file, https://host/file, git-ssh://git@host/repo.git/file, git-https://host/repo.git/file, and oci://[registry/][namespace/]repository[:tag|@digest] formats. ```bash score-compose init --provisioners https://raw.githubusercontent.com/user/repo/main/example.yaml diff --git a/content/en/docs/score implementation/score-k8s/cli.md b/content/en/docs/score implementation/score-k8s/cli.md index f5ae31b..8a7ff7c 100644 --- a/content/en/docs/score implementation/score-k8s/cli.md +++ b/content/en/docs/score implementation/score-k8s/cli.md @@ -39,6 +39,14 @@ Disables the generation of the sample Score file if you already have a Score fil score-k8s init --no-sample ``` +#### `--provisioners` + +Loads additional provisoners from a remote url. May be specified multiple times. Supports http://host/file, https://host/file, git-ssh://git@host/repo.git/file, git-https://host/repo.git/file, and oci://[registry/][namespace/]repository[:tag|@digest] formats. + +```bash +score-k8s init --provisioners https://raw.githubusercontent.com/user/repo/main/example.yaml +``` + #### `--help` | `-h` Displays help information for `init`, providing a short description of the command along with examples and compatible flags. From dbd8ddb7cafa452e89097479e5abc948a017ad9d Mon Sep 17 00:00:00 2001 From: 7h3-3mp7y-m4n Date: Sun, 3 Nov 2024 21:14:44 +0530 Subject: [PATCH 2/3] Added bullet points Signed-off-by: 7h3-3mp7y-m4n --- content/en/docs/score implementation/score-compose/cli.md | 7 ++++++- content/en/docs/score implementation/score-k8s/cli.md | 7 ++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/content/en/docs/score implementation/score-compose/cli.md b/content/en/docs/score implementation/score-compose/cli.md index 91acd4f..643d849 100644 --- a/content/en/docs/score implementation/score-compose/cli.md +++ b/content/en/docs/score implementation/score-compose/cli.md @@ -49,7 +49,12 @@ score-compose init --project score-compose2 #### `--provisioners` | `-p` -Loads additional provisoners from a remote url. May be specified multiple times. Supports http://host/file, https://host/file, git-ssh://git@host/repo.git/file, git-https://host/repo.git/file, and oci://[registry/][namespace/]repository[:tag|@digest] formats. +Loads additional provisoners from a remote url. May be specified multiple times. Supports the following formats: + - `http://host/file` + - `https://host/file` + - `git-ssh://git@host/repo.git/file` + - `git-https://host/repo.git/file` + - `oci://[registry/][namespace/]repository[:tag|@digest][#file]` ```bash score-compose init --provisioners https://raw.githubusercontent.com/user/repo/main/example.yaml diff --git a/content/en/docs/score implementation/score-k8s/cli.md b/content/en/docs/score implementation/score-k8s/cli.md index 8a7ff7c..a19c014 100644 --- a/content/en/docs/score implementation/score-k8s/cli.md +++ b/content/en/docs/score implementation/score-k8s/cli.md @@ -41,7 +41,12 @@ score-k8s init --no-sample #### `--provisioners` -Loads additional provisoners from a remote url. May be specified multiple times. Supports http://host/file, https://host/file, git-ssh://git@host/repo.git/file, git-https://host/repo.git/file, and oci://[registry/][namespace/]repository[:tag|@digest] formats. +Loads additional provisoners from a remote url. May be specified multiple times. Supports the following formats: + - `http://host/file` + - `https://host/file` + - `git-ssh://git@host/repo.git/file` + - `git-https://host/repo.git/file` + - `oci://[registry/][namespace/]repository[:tag|@digest][#file]` ```bash score-k8s init --provisioners https://raw.githubusercontent.com/user/repo/main/example.yaml From 371ca1afe9604f07afda1be2dab34721046f6766 Mon Sep 17 00:00:00 2001 From: 7h3-3mp7y-m4n Date: Sun, 3 Nov 2024 21:23:45 +0530 Subject: [PATCH 3/3] formatted Signed-off-by: 7h3-3mp7y-m4n --- .../en/docs/score implementation/score-compose/cli.md | 11 ++++++----- content/en/docs/score implementation/score-k8s/cli.md | 11 ++++++----- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/content/en/docs/score implementation/score-compose/cli.md b/content/en/docs/score implementation/score-compose/cli.md index 643d849..ae250b2 100644 --- a/content/en/docs/score implementation/score-compose/cli.md +++ b/content/en/docs/score implementation/score-compose/cli.md @@ -50,11 +50,12 @@ score-compose init --project score-compose2 #### `--provisioners` | `-p` Loads additional provisoners from a remote url. May be specified multiple times. Supports the following formats: - - `http://host/file` - - `https://host/file` - - `git-ssh://git@host/repo.git/file` - - `git-https://host/repo.git/file` - - `oci://[registry/][namespace/]repository[:tag|@digest][#file]` + +- `http://host/file` +- `https://host/file` +- `git-ssh://git@host/repo.git/file` +- `git-https://host/repo.git/file` +- `oci://[registry/][namespace/]repository[:tag|@digest][#file]` ```bash score-compose init --provisioners https://raw.githubusercontent.com/user/repo/main/example.yaml diff --git a/content/en/docs/score implementation/score-k8s/cli.md b/content/en/docs/score implementation/score-k8s/cli.md index a328710..572a953 100644 --- a/content/en/docs/score implementation/score-k8s/cli.md +++ b/content/en/docs/score implementation/score-k8s/cli.md @@ -42,11 +42,12 @@ score-k8s init --no-sample #### `--provisioners` Loads additional provisoners from a remote url. May be specified multiple times. Supports the following formats: - - `http://host/file` - - `https://host/file` - - `git-ssh://git@host/repo.git/file` - - `git-https://host/repo.git/file` - - `oci://[registry/][namespace/]repository[:tag|@digest][#file]` + +- `http://host/file` +- `https://host/file` +- `git-ssh://git@host/repo.git/file` +- `git-https://host/repo.git/file` +- `oci://[registry/][namespace/]repository[:tag|@digest][#file]` ```bash score-k8s init --provisioners https://raw.githubusercontent.com/user/repo/main/example.yaml