mods

Documentation

Index

• Constants
• Variables
• func ComponentDef(ctx context.Context, c common.Args, opt Options)
• func PolicyDef(ctx context.Context, c common.Args, opt Options)
• func TraitDef(ctx context.Context, c common.Args, opt Options)
• func WorkflowDef(ctx context.Context, c common.Args, opt Options)
• type Options

Constants

const (
	// ComponentDefRefPath is the target path for kubevela.io component ref docs
	ComponentDefRefPath = "../kubevela.io/docs/end-user/components/references.md"
	// ComponentDefRefPathZh is the target path for kubevela.io component ref docs in Chinese
	ComponentDefRefPathZh = "../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/references.md"
)

const (
	// PolicyDefRefPath is the target path for kubevela.io policy ref docs
	PolicyDefRefPath = "../kubevela.io/docs/end-user/policies/references.md"
	// PolicyDefRefPathZh is the target path for kubevela.io policy ref docs in Chinese
	PolicyDefRefPathZh = "../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/end-user/policies/references.md"
)

const (
	// TraitDefRefPath is the target path for kubevela.io trait ref docs
	TraitDefRefPath = "../kubevela.io/docs/end-user/traits/references.md"
	// TraitDefRefPathZh is the target path for kubevela.io trait ref docs in Chinese
	TraitDefRefPathZh = "../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/end-user/traits/references.md"
)

const (
	// WorkflowDefRefPath is the target path for kubevela.io workflow ref docs
	WorkflowDefRefPath = "../kubevela.io/docs/end-user/workflow/built-in-workflow-defs.md"
	// WorkflowDefRefPathZh is the target path for kubevela.io workflow ref docs in Chinese
	WorkflowDefRefPathZh = "../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/end-user/workflow/built-in-workflow-defs.md"
)

Variables

var ComponentDefDirs = []string{"./vela-templates/definitions/internal/component/"}

ComponentDefDirs store inner CUE definition

var CustomComponentHeaderEN = `---
title: Built-in ParsedComponents Type
---

This documentation will walk through all the built-in component types sorted alphabetically.

` + fmt.Sprintf("> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at %s.\n\n", time.Now().Format(time.RFC3339))

CustomComponentHeaderEN .

var CustomComponentHeaderZH = `---
title: 内置组件列表
---

本文档将**按字典序**展示所有内置组件的参数列表。

` + fmt.Sprintf("> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 %s。\n\n", time.Now().Format(time.RFC3339))

CustomComponentHeaderZH .

var CustomPolicyHeaderEN = `---
title: Built-in Policy Type
---

This documentation will walk through all the built-in policy types sorted alphabetically.

` + fmt.Sprintf("> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at %s.\n\n", time.Now().Format(time.RFC3339))

CustomPolicyHeaderEN .

var CustomPolicyHeaderZH = `---
title: 内置策略列表
---

本文档将**按字典序**展示所有内置策略的参数列表。

` + fmt.Sprintf("> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 %s。\n\n", time.Now().Format(time.RFC3339))

CustomPolicyHeaderZH .

var CustomTraitHeaderEN = `---
title: Built-in Trait Type
---

This documentation will walk through all the built-in trait types sorted alphabetically.

` + fmt.Sprintf("> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at %s.\n\n", time.Now().Format(time.RFC3339))

CustomTraitHeaderEN .

var CustomTraitHeaderZH = `---
title: 内置运维特征列表
---

本文档将**按字典序**展示所有内置运维特征的参数列表。

` + fmt.Sprintf("> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 %s。\n\n", time.Now().Format(time.RFC3339))

CustomTraitHeaderZH .

var CustomWorkflowHeaderEN = `---
title: Built-in WorkflowStep Type
---

This documentation will walk through all the built-in workflow step types sorted alphabetically.

` + fmt.Sprintf("> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at %s.\n\n", time.Now().Format(time.RFC3339))

CustomWorkflowHeaderEN .

var CustomWorkflowHeaderZH = `---
title: 内置工作流步骤列表
---

本文档将**按字典序**展示所有内置工作流步骤的参数列表。

` + fmt.Sprintf("> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 %s。\n\n", time.Now().Format(time.RFC3339))

CustomWorkflowHeaderZH .

var PolicyDefDirs = []string{"./vela-templates/definitions/internal/policy/"}

PolicyDefDirs store inner CUE definition

var TraitDefDirs = []string{"./vela-templates/definitions/internal/trait/"}

TraitDefDirs store inner CUE definition

var WorkflowDefDirs = []string{"./vela-templates/definitions/internal/workflowstep/", "../catalog/addons/vela-workflow/definitions"}

WorkflowDefDirs store inner CUE definition

Functions

func ComponentDef

func ComponentDef(ctx context.Context, c common.Args, opt Options)

ComponentDef generate component def reference doc

func PolicyDef

func PolicyDef(ctx context.Context, c common.Args, opt Options)

PolicyDef generate policy def reference doc

func TraitDef

func TraitDef(ctx context.Context, c common.Args, opt Options)

TraitDef generate trait def reference doc

func WorkflowDef

func WorkflowDef(ctx context.Context, c common.Args, opt Options)

WorkflowDef generate workflow def reference doc

Types

type Options

type Options struct {
	Path          string
	Location      string
	DefDirs       []string
	ForceExamples bool
}

Options defines the doc generate options