From 6bc83ed26914b1eb73d09191af9ba6acc8d5336b Mon Sep 17 00:00:00 2001 From: Jianbo Sun Date: Thu, 14 Jul 2022 17:52:37 +0800 Subject: [PATCH] Update cli ref doc Signed-off-by: Jianbo Sun --- docs/contributor/cli-ref-doc.md | 12 +++++++++--- .../components/component-terraform.md | 2 +- .../current/contributor/cli-ref-doc.md | 4 ++-- .../version-v1.4/contributor/cli-ref-doc.md | 4 ++-- .../version-v1.3/contributor/cli-ref-doc.md | 4 ++-- .../version-v1.4/contributor/cli-ref-doc.md | 4 ++-- 6 files changed, 18 insertions(+), 12 deletions(-) diff --git a/docs/contributor/cli-ref-doc.md b/docs/contributor/cli-ref-doc.md index f8f2fd8b..b2c4d220 100644 --- a/docs/contributor/cli-ref-doc.md +++ b/docs/contributor/cli-ref-doc.md @@ -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 ``` \ No newline at end of file diff --git a/docs/platform-engineers/components/component-terraform.md b/docs/platform-engineers/components/component-terraform.md index 0969dcb6..cffa65f9 100644 --- a/docs/platform-engineers/components/component-terraform.md +++ b/docs/platform-engineers/components/component-terraform.md @@ -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 ``` diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/contributor/cli-ref-doc.md b/i18n/zh/docusaurus-plugin-content-docs/current/contributor/cli-ref-doc.md index f8f2fd8b..49ee755d 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/contributor/cli-ref-doc.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/contributor/cli-ref-doc.md @@ -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 ``` diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.4/contributor/cli-ref-doc.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.4/contributor/cli-ref-doc.md index f8f2fd8b..49ee755d 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.4/contributor/cli-ref-doc.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.4/contributor/cli-ref-doc.md @@ -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 ``` diff --git a/versioned_docs/version-v1.3/contributor/cli-ref-doc.md b/versioned_docs/version-v1.3/contributor/cli-ref-doc.md index 3764c055..18b514dd 100644 --- a/versioned_docs/version-v1.3/contributor/cli-ref-doc.md +++ b/versioned_docs/version-v1.3/contributor/cli-ref-doc.md @@ -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 ``` diff --git a/versioned_docs/version-v1.4/contributor/cli-ref-doc.md b/versioned_docs/version-v1.4/contributor/cli-ref-doc.md index f8f2fd8b..49ee755d 100644 --- a/versioned_docs/version-v1.4/contributor/cli-ref-doc.md +++ b/versioned_docs/version-v1.4/contributor/cli-ref-doc.md @@ -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 ```