Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: rewrite gendocs to generate en/zh docs for one time #193

Merged
merged 1 commit into from
Dec 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 0 additions & 36 deletions cmd/gendocs/gen_kusionctl_docs.go

This file was deleted.

52 changes: 52 additions & 0 deletions scripts/gen-docs/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
package main

import (
"bytes"
"io"
"os"
"path/filepath"

"github.com/spf13/cobra/doc"

"kusionstack.io/kusion/pkg/kusionctl/cmd"
"kusionstack.io/kusion/pkg/log"
uio "kusionstack.io/kusion/pkg/util/io"
)

var docsMatrix = map[string]string{
"en": "en_US.UTF-8",
"zh": "zh_CN.UTF-8",
}

func main() {
// use os.Args instead of "flags" because "flags" will mess up the man pages!
path := "docs/cmd/"
if len(os.Args) == 2 {
path = os.Args[1]
} else if len(os.Args) > 2 {
log.Fatal("usage: %s [output directory]\n", os.Args[0])
}

outDir, err := uio.OutDir(path)
if err != nil {
log.Fatal(os.Stderr, "failed to get output directory: %v\n", err)
}

genDocs(outDir)
}

func genDocs(rootDir string) {
for langDir, lang := range docsMatrix {
targetDir := filepath.Join(rootDir, langDir)
if err := os.MkdirAll(targetDir, os.ModePerm); err != nil {
log.Fatal("make target dir '%s' failed: %v", targetDir, err)
}
if err := os.Setenv("LANG", lang); err != nil {
log.Fatal("set env 'LANG' to '%s' failed: %v", lang, err)
}
command := cmd.NewKusionctlCmd(bytes.NewReader(nil), io.Discard, io.Discard)
if err := doc.GenMarkdownTree(command, targetDir); err != nil {
log.Fatal("generate markdown tree failed: %v", err)
}
}
}