diff --git a/docs/en/_sidebar.md b/docs/en/_sidebar.md index 35bfe8648..d812ebfac 100644 --- a/docs/en/_sidebar.md +++ b/docs/en/_sidebar.md @@ -56,16 +56,8 @@ - [vela port-forward](/en/cli/vela_port-forward.md) - [vela show](/en/cli/vela_show.md) - [vela status](/en/cli/vela_status.md) - - [vela svc](/en/cli/vela_svc.md) - [vela workloads](/en/cli/vela_workloads.md) - [vela traits](/en/cli/vela_traits.md) - - [vela scaler](/en/cli/vela_scaler.md) - - [vela route](/en/cli/vela_route.md) - - [vela autoscale](/en/cli/vela_autoscale.md) - - [vela rollout](/en/cli/vela_rollout.md) - - [vela metrics](/en/cli/vela_metrics.md) - - [vela completion](/en/cli/vela_completion.md) - - [vela dashboard](/en/cli/vela_dashboard.md) - [vela system](/en/cli/vela_system.md) - [vela template](/en/cli/vela_template.md) - [vela cap](/en/cli/vela_cap.md) diff --git a/docs/en/cli/vela.md b/docs/en/cli/vela.md index de697c225..b30fea170 100644 --- a/docs/en/cli/vela.md +++ b/docs/en/cli/vela.md @@ -22,10 +22,10 @@ vela [flags] * [vela env](vela_env.md) - Manage environments * [vela exec](vela_exec.md) - Execute command in a container * [vela export](vela_export.md) - Export deploy manifests from appfile +* [vela help](vela_help.md) - Help about any command * [vela init](vela_init.md) - Create scaffold for an application -* [vela install](vela_install.md) - Install Vela Core with built-in capabilities * [vela logs](vela_logs.md) - Tail logs for application -* [vela ls](vela_ls.md) - List services +* [vela ls](vela_ls.md) - List applications * [vela port-forward](vela_port-forward.md) - Forward local ports to services in an application * [vela show](vela_show.md) - Show the reference doc for a workload type or trait * [vela status](vela_status.md) - Show status of an application @@ -36,4 +36,4 @@ vela [flags] * [vela version](vela_version.md) - Prints out build version information * [vela workloads](vela_workloads.md) - List workloads -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_cap.md b/docs/en/cli/vela_cap.md index 0f1a26fd9..40740483e 100644 --- a/docs/en/cli/vela_cap.md +++ b/docs/en/cli/vela_cap.md @@ -26,4 +26,4 @@ Manage capability centers and installing/uninstalling capabilities * [vela cap ls](vela_cap_ls.md) - List capabilities from cap-center * [vela cap uninstall](vela_cap_uninstall.md) - Uninstall capability from cluster -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_cap_center.md b/docs/en/cli/vela_cap_center.md index 0e72a27f8..2f6562d84 100644 --- a/docs/en/cli/vela_cap_center.md +++ b/docs/en/cli/vela_cap_center.md @@ -26,4 +26,4 @@ Manage Capability Center with config, sync, list * [vela cap center remove](vela_cap_center_remove.md) - Remove specified capability center * [vela cap center sync](vela_cap_center_sync.md) - Sync capabilities from remote center, default to sync all centers -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_cap_center_config.md b/docs/en/cli/vela_cap_center_config.md index f5916bd90..f338d9f33 100644 --- a/docs/en/cli/vela_cap_center_config.md +++ b/docs/en/cli/vela_cap_center_config.md @@ -33,4 +33,4 @@ vela cap center config mycenter https://github.com/oam-dev/catalog/cap-center * [vela cap center](vela_cap_center.md) - Manage Capability Center -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_cap_center_ls.md b/docs/en/cli/vela_cap_center_ls.md index 5f659bf72..70c7f0762 100644 --- a/docs/en/cli/vela_cap_center_ls.md +++ b/docs/en/cli/vela_cap_center_ls.md @@ -32,4 +32,4 @@ vela cap center ls * [vela cap center](vela_cap_center.md) - Manage Capability Center -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_cap_center_remove.md b/docs/en/cli/vela_cap_center_remove.md index 7bcab29f5..b280cb3bc 100644 --- a/docs/en/cli/vela_cap_center_remove.md +++ b/docs/en/cli/vela_cap_center_remove.md @@ -32,4 +32,4 @@ vela cap center remove mycenter * [vela cap center](vela_cap_center.md) - Manage Capability Center -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_cap_center_sync.md b/docs/en/cli/vela_cap_center_sync.md index 254bcb26f..0765fc42c 100644 --- a/docs/en/cli/vela_cap_center_sync.md +++ b/docs/en/cli/vela_cap_center_sync.md @@ -32,4 +32,4 @@ vela cap center sync mycenter * [vela cap center](vela_cap_center.md) - Manage Capability Center -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_cap_install.md b/docs/en/cli/vela_cap_install.md index df25796ca..97fdc648f 100644 --- a/docs/en/cli/vela_cap_install.md +++ b/docs/en/cli/vela_cap_install.md @@ -33,4 +33,4 @@ vela cap install mycenter/route * [vela cap](vela_cap.md) - Manage capability centers and installing/uninstalling capabilities -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_cap_ls.md b/docs/en/cli/vela_cap_ls.md index ed0d07307..b5e32a8bd 100644 --- a/docs/en/cli/vela_cap_ls.md +++ b/docs/en/cli/vela_cap_ls.md @@ -32,4 +32,4 @@ vela cap ls * [vela cap](vela_cap.md) - Manage capability centers and installing/uninstalling capabilities -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_cap_uninstall.md b/docs/en/cli/vela_cap_uninstall.md index 989822d38..d7c8880d4 100644 --- a/docs/en/cli/vela_cap_uninstall.md +++ b/docs/en/cli/vela_cap_uninstall.md @@ -33,4 +33,4 @@ vela cap uninstall route * [vela cap](vela_cap.md) - Manage capability centers and installing/uninstalling capabilities -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_completion.md b/docs/en/cli/vela_completion.md index 13fc3437c..fa48da230 100644 --- a/docs/en/cli/vela_completion.md +++ b/docs/en/cli/vela_completion.md @@ -27,4 +27,4 @@ of vela commands. * [vela completion bash](vela_completion_bash.md) - generate autocompletions script for bash * [vela completion zsh](vela_completion_zsh.md) - generate autocompletions script for zsh -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_completion_bash.md b/docs/en/cli/vela_completion_bash.md index 1d78adbd9..481664a87 100644 --- a/docs/en/cli/vela_completion_bash.md +++ b/docs/en/cli/vela_completion_bash.md @@ -36,4 +36,4 @@ vela completion bash * [vela completion](vela_completion.md) - Output shell completion code for the specified shell (bash or zsh) -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_completion_zsh.md b/docs/en/cli/vela_completion_zsh.md index 27ed42f7d..043ea05a7 100644 --- a/docs/en/cli/vela_completion_zsh.md +++ b/docs/en/cli/vela_completion_zsh.md @@ -33,4 +33,4 @@ vela completion zsh * [vela completion](vela_completion.md) - Output shell completion code for the specified shell (bash or zsh) -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_config.md b/docs/en/cli/vela_config.md index 184726496..2312cd132 100644 --- a/docs/en/cli/vela_config.md +++ b/docs/en/cli/vela_config.md @@ -26,4 +26,4 @@ Manage configurations * [vela config ls](vela_config_ls.md) - List configs * [vela config set](vela_config_set.md) - Set data for a config -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_config_del.md b/docs/en/cli/vela_config_del.md index 8d5e87c4f..af9cb2766 100644 --- a/docs/en/cli/vela_config_del.md +++ b/docs/en/cli/vela_config_del.md @@ -32,4 +32,4 @@ vela config del * [vela config](vela_config.md) - Manage configurations -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_config_get.md b/docs/en/cli/vela_config_get.md index 0cda12f20..155f0da60 100644 --- a/docs/en/cli/vela_config_get.md +++ b/docs/en/cli/vela_config_get.md @@ -32,4 +32,4 @@ vela config get * [vela config](vela_config.md) - Manage configurations -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_config_ls.md b/docs/en/cli/vela_config_ls.md index cf8dde15f..79ac4de4d 100644 --- a/docs/en/cli/vela_config_ls.md +++ b/docs/en/cli/vela_config_ls.md @@ -32,4 +32,4 @@ vela config ls * [vela config](vela_config.md) - Manage configurations -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_config_set.md b/docs/en/cli/vela_config_set.md index 3c0d6fe20..3223b8843 100644 --- a/docs/en/cli/vela_config_set.md +++ b/docs/en/cli/vela_config_set.md @@ -32,4 +32,4 @@ vela config set KEY=VALUE K2=V2 * [vela config](vela_config.md) - Manage configurations -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_delete.md b/docs/en/cli/vela_delete.md index aa83b3c3b..267844eac 100644 --- a/docs/en/cli/vela_delete.md +++ b/docs/en/cli/vela_delete.md @@ -33,4 +33,4 @@ vela delete frontend * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_env.md b/docs/en/cli/vela_env.md index be9f8ccc1..9693adc52 100644 --- a/docs/en/cli/vela_env.md +++ b/docs/en/cli/vela_env.md @@ -26,4 +26,4 @@ Manage environments * [vela env ls](vela_env_ls.md) - List environments * [vela env set](vela_env_set.md) - Set an environment -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_env_delete.md b/docs/en/cli/vela_env_delete.md index 947e0e23d..80a345aaf 100644 --- a/docs/en/cli/vela_env_delete.md +++ b/docs/en/cli/vela_env_delete.md @@ -32,4 +32,4 @@ vela env delete test * [vela env](vela_env.md) - Manage environments -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_env_init.md b/docs/en/cli/vela_env_init.md index 8f41cc750..3098a8947 100644 --- a/docs/en/cli/vela_env_init.md +++ b/docs/en/cli/vela_env_init.md @@ -35,4 +35,4 @@ vela env init test --namespace test --email my@email.com * [vela env](vela_env.md) - Manage environments -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_env_ls.md b/docs/en/cli/vela_env_ls.md index 9a71f99c3..566d42b22 100644 --- a/docs/en/cli/vela_env_ls.md +++ b/docs/en/cli/vela_env_ls.md @@ -32,4 +32,4 @@ vela env ls [env-name] * [vela env](vela_env.md) - Manage environments -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_env_set.md b/docs/en/cli/vela_env_set.md index dd45c663a..c0c36bd76 100644 --- a/docs/en/cli/vela_env_set.md +++ b/docs/en/cli/vela_env_set.md @@ -32,4 +32,4 @@ vela env set test * [vela env](vela_env.md) - Manage environments -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_exec.md b/docs/en/cli/vela_exec.md index 5ee99602f..967a08ca1 100644 --- a/docs/en/cli/vela_exec.md +++ b/docs/en/cli/vela_exec.md @@ -30,4 +30,4 @@ vela exec [flags] APP_NAME -- COMMAND [args...] * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_export.md b/docs/en/cli/vela_export.md index 7d6581db1..a348c5c3e 100644 --- a/docs/en/cli/vela_export.md +++ b/docs/en/cli/vela_export.md @@ -27,4 +27,4 @@ vela export * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_help.md b/docs/en/cli/vela_help.md new file mode 100644 index 000000000..1d583aef4 --- /dev/null +++ b/docs/en/cli/vela_help.md @@ -0,0 +1,25 @@ +## vela help + +Help about any command + +``` +vela help [command] +``` + +### Options + +``` + -h, --help help for help +``` + +### Options inherited from parent commands + +``` + -e, --env string specify environment name for application +``` + +### SEE ALSO + +* [vela](vela.md) - + +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_init.md b/docs/en/cli/vela_init.md index e5807eabf..3c8188cce 100644 --- a/docs/en/cli/vela_init.md +++ b/docs/en/cli/vela_init.md @@ -33,4 +33,4 @@ vela init * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_install.md b/docs/en/cli/vela_install.md deleted file mode 100644 index c9fd582f2..000000000 --- a/docs/en/cli/vela_install.md +++ /dev/null @@ -1,35 +0,0 @@ -## vela install - -Install Vela Core with built-in capabilities - -### Synopsis - -Install Vela Core with built-in capabilities - -``` -vela install [flags] -``` - -### Options - -``` - -h, --help help for install - --image-pull-policy string vela core image pull policy, this will align to chart value image.pullPolicy - --image-repo string vela core image repo, this will align to chart value image.repo - --image-tag string vela core image repo, this will align to chart value image.tag - -s, --set strings arguments for installing vela-core chart - -p, --vela-chart-path string path to vela core chart to override default chart - -w, --wait string wait until vela-core is ready to serve, default will not wait (default "0s") -``` - -### Options inherited from parent commands - -``` - -e, --env string specify environment name for application -``` - -### SEE ALSO - -* [vela](vela.md) - - -###### Auto generated by spf13/cobra on 28-Jan-2021 diff --git a/docs/en/cli/vela_logs.md b/docs/en/cli/vela_logs.md index 842792e0b..29f18913c 100644 --- a/docs/en/cli/vela_logs.md +++ b/docs/en/cli/vela_logs.md @@ -27,4 +27,4 @@ vela logs [flags] * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_ls.md b/docs/en/cli/vela_ls.md index 40d846ee0..812164ddd 100644 --- a/docs/en/cli/vela_ls.md +++ b/docs/en/cli/vela_ls.md @@ -1,10 +1,10 @@ ## vela ls -List services +List applications ### Synopsis -List services of all applications +List all applications in cluster ``` vela ls @@ -19,8 +19,8 @@ vela ls ### Options ``` - --app string specify the name of application - -h, --help help for ls + -h, --help help for ls + -n, --namespace string specify the namespace the application want to list, default is the current env namespace ``` ### Options inherited from parent commands @@ -33,4 +33,4 @@ vela ls * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_port-forward.md b/docs/en/cli/vela_port-forward.md index cab6580c8..9bf49cfec 100644 --- a/docs/en/cli/vela_port-forward.md +++ b/docs/en/cli/vela_port-forward.md @@ -35,4 +35,4 @@ port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMO * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_show.md b/docs/en/cli/vela_show.md index 736933c31..5dc004c62 100644 --- a/docs/en/cli/vela_show.md +++ b/docs/en/cli/vela_show.md @@ -33,4 +33,4 @@ show webservice * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_status.md b/docs/en/cli/vela_status.md index e03423b77..17d2c4ffb 100644 --- a/docs/en/cli/vela_status.md +++ b/docs/en/cli/vela_status.md @@ -33,4 +33,4 @@ vela status APP_NAME * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_system.md b/docs/en/cli/vela_system.md index 6cbd94abe..36643827d 100644 --- a/docs/en/cli/vela_system.md +++ b/docs/en/cli/vela_system.md @@ -24,4 +24,4 @@ System management utilities * [vela system dry-run](vela_system_dry-run.md) - Dry Run an application, and output the conversion result to stdout * [vela system info](vela_system_info.md) - Show vela client and cluster chartPath -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_system_dry-run.md b/docs/en/cli/vela_system_dry-run.md index e86f57f4b..27302af2a 100644 --- a/docs/en/cli/vela_system_dry-run.md +++ b/docs/en/cli/vela_system_dry-run.md @@ -33,4 +33,4 @@ vela dry-run * [vela system](vela_system.md) - System management utilities -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_system_info.md b/docs/en/cli/vela_system_info.md index f4972e31e..d54ffc998 100644 --- a/docs/en/cli/vela_system_info.md +++ b/docs/en/cli/vela_system_info.md @@ -26,4 +26,4 @@ vela system info [flags] * [vela system](vela_system.md) - System management utilities -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_template.md b/docs/en/cli/vela_template.md index 524e66c55..f4ae4e694 100644 --- a/docs/en/cli/vela_template.md +++ b/docs/en/cli/vela_template.md @@ -23,4 +23,4 @@ Manage templates * [vela](vela.md) - * [vela template context](vela_template_context.md) - Show context parameters -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_template_context.md b/docs/en/cli/vela_template_context.md index 9d3fe2f21..42cc74d7a 100644 --- a/docs/en/cli/vela_template_context.md +++ b/docs/en/cli/vela_template_context.md @@ -32,4 +32,4 @@ vela template context * [vela template](vela_template.md) - Manage templates -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_traits.md b/docs/en/cli/vela_traits.md index 5f4fc8da8..b9066e53b 100644 --- a/docs/en/cli/vela_traits.md +++ b/docs/en/cli/vela_traits.md @@ -7,7 +7,7 @@ List traits List traits ``` -vela traits [--apply-to WORKLOAD_NAME] +vela traits ``` ### Examples @@ -19,9 +19,7 @@ vela traits ### Options ``` - -r, -- Enforce refresh from cluster even if cache is not expired - --apply-to string Workload name - -h, --help help for traits + -h, --help help for traits ``` ### Options inherited from parent commands @@ -34,4 +32,4 @@ vela traits * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_up.md b/docs/en/cli/vela_up.md index 849ccaace..073fd3186 100644 --- a/docs/en/cli/vela_up.md +++ b/docs/en/cli/vela_up.md @@ -27,4 +27,4 @@ vela up * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_version.md b/docs/en/cli/vela_version.md index 4275e6ad4..bee5e2b8f 100644 --- a/docs/en/cli/vela_version.md +++ b/docs/en/cli/vela_version.md @@ -26,4 +26,4 @@ vela version [flags] * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/cli/vela_workloads.md b/docs/en/cli/vela_workloads.md index e1754ec55..825f51726 100644 --- a/docs/en/cli/vela_workloads.md +++ b/docs/en/cli/vela_workloads.md @@ -19,7 +19,6 @@ vela workloads ### Options ``` - -r, -- Enforce refresh from cluster even if cache is not expired -h, --help help for workloads ``` @@ -33,4 +32,4 @@ vela workloads * [vela](vela.md) - -###### Auto generated by spf13/cobra on 28-Jan-2021 +###### Auto generated by spf13/cobra on 20-Mar-2021 diff --git a/docs/en/developers/references/traits/ingress.md b/docs/en/developers/references/traits/ingress.md new file mode 100644 index 000000000..b11294a5c --- /dev/null +++ b/docs/en/developers/references/traits/ingress.md @@ -0,0 +1,18 @@ +# Ingress + +## Description + +Configures K8s ingress and service to enable web traffic for your service. Please use route trait in cap center for advanced usage. + +## Specification + +List of all configuration options for a `Ingress` trait. + +```yaml``` + +## Properties + +Name | Description | Type | Required | Default +------------ | ------------- | ------------- | ------------- | ------------- + domain | | string | true | + http | | map[string]int | true | diff --git a/references/plugins/references.go b/references/plugins/references.go index 85acd33f7..dd57f1573 100644 --- a/references/plugins/references.go +++ b/references/plugins/references.go @@ -252,10 +252,9 @@ func (ref *MarkdownReference) CreateMarkdown(caps []types.Capability, baseRefPat } specification := fmt.Sprintf("\n\n## Specification\n\n%s\n\n%s", specificationIntro, specificationContent) - conflictWithAndMoreSection, err := ref.generateConflictWithAndMore(capName, referenceSourcePath) - if err != nil { - return err - } + // it's fine if the conflict info files not found + conflictWithAndMoreSection, _ := ref.generateConflictWithAndMore(capName, referenceSourcePath) + refContent = title + description + specification + refContent + conflictWithAndMoreSection if _, err := f.WriteString(refContent); err != nil { return err