From 49257154b54ae0cd9f36f6eb65604dd4e70421a2 Mon Sep 17 00:00:00 2001 From: Yuedong Wu <57584831+lunarwhite@users.noreply.github.com> Date: Sun, 30 Oct 2022 15:13:30 +0800 Subject: [PATCH] docs: fix cue action doc formats (#1024) Signed-off-by: Yuedong Wu <57584831+lunarwhite@users.noreply.github.com> Signed-off-by: Yuedong Wu <57584831+lunarwhite@users.noreply.github.com> --- docs/platform-engineers/workflow/cue-actions.md | 6 ++++-- .../current/platform-engineers/workflow/cue-actions.md | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/platform-engineers/workflow/cue-actions.md b/docs/platform-engineers/workflow/cue-actions.md index 7f225686..2b0f3471 100644 --- a/docs/platform-engineers/workflow/cue-actions.md +++ b/docs/platform-engineers/workflow/cue-actions.md @@ -80,7 +80,7 @@ Write message to the workflow step status. } ``` -## DoVar +### DoVar Used to save or read user-defined data in the context of workflow. @@ -510,6 +510,7 @@ Create or update resources corresponding to the component in Kubernetes cluster. **Parameters** +``` #ApplyComponent: { // +usage=The cluster to use cluster: *"" | string @@ -524,6 +525,7 @@ Create or update resources corresponding to the component in Kubernetes cluster. // +usage=The patcher that will be applied to the resource, you can define the strategy of list merge through comments. Reference doc here: https://kubevela.io/docs/platform-engineers/traits/patch-trait#patch-in-workflow-step patch?: {...} } +``` **Example** @@ -555,7 +557,7 @@ apply: op.#ApplyApplication & {} ## Special Operations -## Steps +### Steps A combination of a set of operations that can be used to implement complex operation logic. diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/workflow/cue-actions.md b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/workflow/cue-actions.md index 7dd17dff..25780f7e 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/workflow/cue-actions.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/workflow/cue-actions.md @@ -79,7 +79,7 @@ fail: op.#Fail & { } ``` -## DoVar +### DoVar 用来在 workflow 的上下文中保存或者读取用户定义的数据 @@ -509,6 +509,7 @@ mycomp: load.value["my-comp"] **参数定义** +``` #ApplyComponent: { // +usage=The cluster to use cluster: *"" | string @@ -523,6 +524,7 @@ mycomp: load.value["my-comp"] // +usage=The patcher that will be applied to the resource, you can define the strategy of list merge through comments. Reference doc here: https://kubevela.io/docs/platform-engineers/traits/patch-trait#patch-in-workflow-step patch?: {...} } +``` **用法示例** @@ -554,7 +556,7 @@ apply: op.#ApplyApplication & {} ## 特殊操作 -## Steps +### Steps 用于一组操作的组合,可以用于实现复杂的操作逻辑。