kubevela
/
kubevela.github.io
mirror of https://github.com/kubevela/kubevela.github.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update cli ref doc 

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
This commit is contained in:
Jianbo Sun 2022-07-14 17:52:37 +08:00
parent ce0370e315
commit 6bc83ed269
6 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contributor/cli-ref-doc.md
View File

@ -1,7 +1,11 @@
---
title: Update CLI Reference
title: Update Reference Docs
---
Here're introduction of how to generate docs automatically from Golang scripts.
## CLI Reference
This guide introduce how to update [CLI reference doc](../cli/vela) in the website.
The whole process was done by script automatically. You need to follow this guide to build your environment.
@ -18,13 +22,13 @@ $ tree -L 1
```shell
cd kubevela/
go run ./hack/docgen/gen.go
go run ./hack/docgen/cli/gen.go
```
3. Update more docs such as i18n zh
```shell
$ go run ./hack/docgen/gen.go ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
$ go run ./hack/docgen/cli/gen.go ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
scanning rootPath of CLI docs for replace: ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
```
@ -33,4 +37,6 @@ scanning rootPath of CLI docs for replace: ../kubevela.io/i18n/zh/docusaurus-pl
```shell
cd ../kubevela.io
git status
ga .
git push
```

2
docs/platform-engineers/components/component-terraform.md
View File

@ -202,7 +202,7 @@ By running `vela def doc-gen` command, we can generate related docs for the Comp
If you choose to generate docs from running cluster, you should provide the name of the ComponentDefinition and the namespace which it is running in.
```shell
$ vela def doc-gen alibaba-eip -n vela-system
$ vela def doc-gen alibaba-eip --path ./kubevela.io/docs/end-user/components/cloud-services/terraform/
Generated docs for alibaba-eip in ./kubevela.io/docs/end-user/components/cloud-services/terraform/alibaba-eip.md
```

4
i18n/zh/docusaurus-plugin-content-docs/current/contributor/cli-ref-doc.md
View File

@ -18,13 +18,13 @@ $ tree -L 1
```shell
cd kubevela/
go run ./hack/docgen/gen.go
go run ./hack/docgen/cli/gen.go
```
3. Update more docs such as i18n zh
```shell
$ go run ./hack/docgen/gen.go ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
$ go run ./hack/docgen/cli/gen.go ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
scanning rootPath of CLI docs for replace: ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
```

4
i18n/zh/docusaurus-plugin-content-docs/version-v1.4/contributor/cli-ref-doc.md
View File

@ -18,13 +18,13 @@ $ tree -L 1
```shell
cd kubevela/
go run ./hack/docgen/gen.go
go run ./hack/docgen/cli/gen.go
```
3. Update more docs such as i18n zh
```shell
$ go run ./hack/docgen/gen.go ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
$ go run ./hack/docgen/cli/gen.go ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
scanning rootPath of CLI docs for replace: ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
```

4
versioned_docs/version-v1.3/contributor/cli-ref-doc.md
View File

@ -13,13 +13,13 @@ $ tree -L 1
```shell
cd kubevela/
go run ./hack/docgen/gen.go
go run ./hack/docgen/cli/gen.go
```
3. Update more docs such as i18n zh
```shell
$ go run ./hack/docgen/gen.go ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
$ go run ./hack/docgen/cli/gen.go ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
scanning rootPath of CLI docs for replace: ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
```

4
versioned_docs/version-v1.4/contributor/cli-ref-doc.md
View File

@ -18,13 +18,13 @@ $ tree -L 1
```shell
cd kubevela/
go run ./hack/docgen/gen.go
go run ./hack/docgen/cli/gen.go
```
3. Update more docs such as i18n zh
```shell
$ go run ./hack/docgen/gen.go ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
$ go run ./hack/docgen/cli/gen.go ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
scanning rootPath of CLI docs for replace: ../kubevela.io/i18n/zh/docusaurus-plugin-content-docs/current/cli
```