Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: modify the registry usage examples for gitlab and github type #1236

Merged
merged 2 commits into from
Jun 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/cli/vela_addon_registry_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ vela addon registry add [flags]

```
add a helm repo registry: vela addon registry add --type=helm my-repo --endpoint=<URL>
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<ptah> --token=<git token>"
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<path> --gitToken=<git token>
add a specified github registry: vela addon registry add my-repo --type git --endpoint=https://github.com/kubevela/catalog --path=addons --gitToken=<git token>
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --token=<git token>
add a specified gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=http://gitlab.xxx.com/xxx/catalog --path=addons --gitlabRepoName=catalog --gitToken=<git token>
```

### Options
Expand All @@ -26,11 +28,11 @@ add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=
--bucket string specify the OSS bucket name
--endpoint string specify the addon registry endpoint
--gitToken string specify the github repo token
--gitlabRepoName string specify the gitlab addon registry repoName
--gitlabRepoName string specify the gitlab addon registry repoName, this option must be set when registry is gitlab
-h, --help help for add
--insecureSkipTLS specify the Helm addon registry skip tls verify
--password string specify the Helm addon registry password
--path string specify the addon registry OSS path
--path string specify the addon registry path, this option must be set when addons are not in root of registry
--type string specify the addon registry type
--username string specify the Helm addon registry username
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ vela addon registry add [flags]

```
add a helm repo registry: vela addon registry add --type=helm my-repo --endpoint=<URL>
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<ptah> --token=<git token>"
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<path> --gitToken=<git token>
add a specified github registry: vela addon registry add my-repo --type git --endpoint=https://github.com/kubevela/catalog --path=addons --gitToken=<git token>
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --token=<git token>
add a specified gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=http://gitlab.xxx.com/xxx/catalog --path=addons --gitlabRepoName=catalog --gitToken=<git token>
```

### Options
Expand All @@ -26,11 +28,11 @@ add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=
--bucket string specify the OSS bucket name
--endpoint string specify the addon registry endpoint
--gitToken string specify the github repo token
--gitlabRepoName string specify the gitlab addon registry repoName
--gitlabRepoName string specify the gitlab addon registry repoName, this option must be set when registry is gitlab
-h, --help help for add
--insecureSkipTLS specify the Helm addon registry skip tls verify
--password string specify the Helm addon registry password
--path string specify the addon registry OSS path
--path string specify the addon registry path, this option must be set when addons are not in root of registry
--type string specify the addon registry type
--username string specify the Helm addon registry username
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ vela addon registry add [flags]

```
add a helm repo registry: vela addon registry add --type=helm my-repo --endpoint=<URL>
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<ptah> --token=<git token>"
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<path> --gitToken=<git token>
add a specified github registry: vela addon registry add my-repo --type git --endpoint=https://github.com/kubevela/catalog --path=addons --gitToken=<git token>
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --token=<git token>
add a specified gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=http://gitlab.xxx.com/xxx/catalog --path=addons --gitlabRepoName=catalog --gitToken=<git token>
```

### Options
Expand All @@ -26,11 +28,11 @@ add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=
--bucket string specify the OSS bucket name
--endpoint string specify the addon registry endpoint
--gitToken string specify the github repo token
--gitlabRepoName string specify the gitlab addon registry repoName
--gitlabRepoName string specify the gitlab addon registry repoName, this option must be set when registry is gitlab
-h, --help help for add
--insecureSkipTLS specify the Helm addon registry skip tls verify
--password string specify the Helm addon registry password
--path string specify the addon registry OSS path
--path string specify the addon registry path, this option must be set when addons are not in root of registry
--type string specify the addon registry type
--username string specify the Helm addon registry username
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ vela addon registry add [flags]

```
add a helm repo registry: vela addon registry add --type=helm my-repo --endpoint=<URL>
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<ptah> --token=<git token>"
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<path> --gitToken=<git token>
add a specified github registry: vela addon registry add my-repo --type git --endpoint=https://github.com/kubevela/catalog --path=addons --gitToken=<git token>
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --token=<git token>
add a specified gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=http://gitlab.xxx.com/xxx/catalog --path=addons --gitlabRepoName=catalog --gitToken=<git token>
```

### Options
Expand All @@ -26,11 +28,11 @@ add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=
--bucket string specify the OSS bucket name
--endpoint string specify the addon registry endpoint
--gitToken string specify the github repo token
--gitlabRepoName string specify the gitlab addon registry repoName
--gitlabRepoName string specify the gitlab addon registry repoName, this option must be set when registry is gitlab
-h, --help help for add
--insecureSkipTLS specify the Helm addon registry skip tls verify
--password string specify the Helm addon registry password
--path string specify the addon registry OSS path
--path string specify the addon registry path, this option must be set when addons are not in root of registry
--type string specify the addon registry type
--username string specify the Helm addon registry username
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ vela addon registry add [flags]

```
add a helm repo registry: vela addon registry add --type=helm my-repo --endpoint=<URL>
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<ptah> --token=<git token>"
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<path> --gitToken=<git token>
add a specified github registry: vela addon registry add my-repo --type git --endpoint=https://github.com/kubevela/catalog --path=addons --gitToken=<git token>
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --token=<git token>
add a specified gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=http://gitlab.xxx.com/xxx/catalog --path=addons --gitlabRepoName=catalog --gitToken=<git token>
```

### Options
Expand All @@ -26,11 +28,11 @@ add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=
--bucket string specify the OSS bucket name
--endpoint string specify the addon registry endpoint
--gitToken string specify the github repo token
--gitlabRepoName string specify the gitlab addon registry repoName
--gitlabRepoName string specify the gitlab addon registry repoName, this option must be set when registry is gitlab
-h, --help help for add
--insecureSkipTLS specify the Helm addon registry skip tls verify
--password string specify the Helm addon registry password
--path string specify the addon registry OSS path
--path string specify the addon registry path, this option must be set when addons are not in root of registry
--type string specify the addon registry type
--username string specify the Helm addon registry username
```
Expand Down
8 changes: 5 additions & 3 deletions versioned_docs/version-v1.6/cli/vela_addon_registry_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ vela addon registry add [flags]

```
add a helm repo registry: vela addon registry add --type=helm my-repo --endpoint=<URL>
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<ptah> --token=<git token>"
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<path> --gitToken=<git token>
add a specified github registry: vela addon registry add my-repo --type git --endpoint=https://github.com/kubevela/catalog --path=addons --gitToken=<git token>
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --token=<git token>
add a specified gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=http://gitlab.xxx.com/xxx/catalog --path=addons --gitlabRepoName=catalog --gitToken=<git token>
```

### Options
Expand All @@ -26,11 +28,11 @@ add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=
--bucket string specify the OSS bucket name
--endpoint string specify the addon registry endpoint
--gitToken string specify the github repo token
--gitlabRepoName string specify the gitlab addon registry repoName
--gitlabRepoName string specify the gitlab addon registry repoName, this option must be set when registry is gitlab
-h, --help help for add
--insecureSkipTLS specify the Helm addon registry skip tls verify
--password string specify the Helm addon registry password
--path string specify the addon registry OSS path
--path string specify the addon registry path, this option must be set when addons are not in root of registry
--type string specify the addon registry type
--username string specify the Helm addon registry username
```
Expand Down
8 changes: 5 additions & 3 deletions versioned_docs/version-v1.7/cli/vela_addon_registry_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ vela addon registry add [flags]

```
add a helm repo registry: vela addon registry add --type=helm my-repo --endpoint=<URL>
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<ptah> --token=<git token>"
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<path> --gitToken=<git token>
add a specified github registry: vela addon registry add my-repo --type git --endpoint=https://github.com/kubevela/catalog --path=addons --gitToken=<git token>
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --token=<git token>
add a specified gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=http://gitlab.xxx.com/xxx/catalog --path=addons --gitlabRepoName=catalog --gitToken=<git token>
```

### Options
Expand All @@ -26,11 +28,11 @@ add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=
--bucket string specify the OSS bucket name
--endpoint string specify the addon registry endpoint
--gitToken string specify the github repo token
--gitlabRepoName string specify the gitlab addon registry repoName
--gitlabRepoName string specify the gitlab addon registry repoName, this option must be set when registry is gitlab
-h, --help help for add
--insecureSkipTLS specify the Helm addon registry skip tls verify
--password string specify the Helm addon registry password
--path string specify the addon registry OSS path
--path string specify the addon registry path, this option must be set when addons are not in root of registry
--type string specify the addon registry type
--username string specify the Helm addon registry username
```
Expand Down
8 changes: 5 additions & 3 deletions versioned_docs/version-v1.8/cli/vela_addon_registry_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ vela addon registry add [flags]

```
add a helm repo registry: vela addon registry add --type=helm my-repo --endpoint=<URL>
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<ptah> --token=<git token>"
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<path> --gitToken=<git token>
add a specified github registry: vela addon registry add my-repo --type git --endpoint=https://github.com/kubevela/catalog --path=addons --gitToken=<git token>
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --token=<git token>
add a specified gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=http://gitlab.xxx.com/xxx/catalog --path=addons --gitlabRepoName=catalog --gitToken=<git token>
```

### Options
Expand All @@ -26,11 +28,11 @@ add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=
--bucket string specify the OSS bucket name
--endpoint string specify the addon registry endpoint
--gitToken string specify the github repo token
--gitlabRepoName string specify the gitlab addon registry repoName
--gitlabRepoName string specify the gitlab addon registry repoName, this option must be set when registry is gitlab
-h, --help help for add
--insecureSkipTLS specify the Helm addon registry skip tls verify
--password string specify the Helm addon registry password
--path string specify the addon registry OSS path
--path string specify the addon registry path, this option must be set when addons are not in root of registry
--type string specify the addon registry type
--username string specify the Helm addon registry username
```
Expand Down