add website

sunny0826 · Nov 24, 2020 · f386fda · f386fda
1 parent fa9c3cf
commit f386fda
Show file tree

Hide file tree

Showing 60 changed files with 2,363 additions and 365 deletions.
diff --git a/Makefile b/Makefile
@@ -72,6 +72,9 @@ lint: golangci
 test: fmt vet lint
 		go test -race -coverprofile=coverage.txt -covermode=atomic ./cmd/...
 
+doc-gen:
+	rm -r docs/en/cli/*
+	go run hack/docgen/gen.go
 
 GOLANGCILINT_VERSION ?= v1.29.0
 HOSTOS := $(shell uname -s | tr '[:upper:]' '[:lower:]')

diff --git a/README.md b/README.md
@@ -1,5 +1,3 @@
-English | [简体中文](docs/README_CN.md)
-
 # KubeCM
 
 ![Go](https://github.com/sunny0826/kubecm/workflows/Go/badge.svg?branch=master)
@@ -43,151 +41,9 @@ Flags:
 Use "kubecm [command] --help" for more information about a command.
 ```
 
-## Quick Start
-
-### Install
-
-#### Homebrew
-
-```bash
-brew install sunny0826/tap/kubecm
-```
-
-#### Download the binary
-
-[![GitHub release](https://img.shields.io/github/release/sunny0826/kubecm)](https://github.com/sunny0826/kubecm/releases)
-
-```bash
-# linux x86_64
-curl -Lo kubecm.tar.gz https://github.com/sunny0826/kubecm/releases/download/v${VERSION}/kubecm_${VERSION}_Linux_x86_64.tar.gz
-# macos
-curl -Lo kubecm.tar.gz https://github.com/sunny0826/kubecm/releases/download/v${VERSION}/kubecm_${VERSION}_Darwin_x86_64.tar.gz
-# windows
-curl -Lo kubecm.tar.gz https://github.com/sunny0826/kubecm/releases/download/v${VERSION}/kubecm_${VERSION}_Windows_x86_64.tar.gz
-
-# linux & macos
-tar -zxvf kubecm.tar.gz kubecm
-cd kubecm
-sudo mv kubecm /usr/local/bin/
-
-# windows
-# Unzip kubecm.tar.gz
-# Add the binary in to your $PATH
-```
-
-### Auto-Completion
-
-#### bash
-
-```bash
-# bash
-kubecm completion bash > ~/.kube/kubecm.bash.inc
-printf "
-# kubecm shell completion
-source '$HOME/.kube/kubecm.bash.inc'
-" >> $HOME/.bash_profile
-source $HOME/.bash_profile
-```
-
-#### zsh
-
-```bash
-# add to $HOME/.zshrc 
-source <(kubecm completion zsh)
-# or
-kubecm completion zsh > "${fpath[1]}/_kubecm"
-```
-
-### Interactive operation
-
-![Interactive](docs/Interaction.gif)
-
-### List Kube Context
-
-```shell script
-# List all the contexts in your kubeconfig file
-kubecm ls
-# Aliases
-kubecm l
-```
-
-### Generate alias
-
-Generate alias for all contexts.
-
-```shell script
-$ kubecm alias
-# dev 
-alias k-dev='kubectl --context dev'
-# test
-alias k-test='kubectl --context test'
-# prod
-alias k-prod='kubectl --context prod'
-$ kubecm alias -o zsh
-# add alias context to ~/.zshrc
-$ kubecm alias -o bash
-# add alias context to ~/.bash_profile
-```
-
-### Add configuration to `$HOME/.kube/config`
-
-```shell script
-# Merge example.yaml with $HOME/.kube/config.yaml
-kubecm add -f example.yaml 
-
-# Merge example.yaml and name contexts test with $HOME/.kube/config.yaml
-kubecm add -f example.yaml -n test
-
-# Overwrite the original kubeconfig file
-kubecm add -f example.yaml -c
-```
-
-### Merge the kubeconfig
-
-```shell script
-# Merge kubeconfig in the directory
-kubecm merge -f dir
-
-# Merge kubeconfig in the directory and overwrite the original kubeconfig file
-kubecm merge -f dir -c
-```
-
-### Switch Kube Context interactively
-
-```shell script
-# Switch Kube Context interactively
-kubecm switch
-```
-![switch](docs/switch.gif)
-
-### Delete context
-
-```shell script
-# Delete the context interactively
-kubecm delete
-# Delete the context
-kubecm delete my-context
-```
-### Rename context
-
-```shell script
-# Renamed the context interactively
-kubecm rename
-```
-
-### Switch namespace
-
-You can switch namespace or switch namespace interactively
+## Documentation
 
-```shell script
-# Switch Namespace interactively
-kubecm namespace
-# or
-kubecm ns
-# change to namespace of kube-system
-kubecm ns kube-system
-``` 
-![ns](docs/ns.gif)
+For full documentation, please visit the KubeVela website: [https://kubecm.cloud](https://kubecm.cloud)
 
 ## Video
 
@@ -203,6 +59,6 @@ Feel free to open issues and pull requests. Any feedback is highly appreciated!
 
 <p align="center">
   <a href="https://www.jetbrains.com/?from=kubecm" title="前往官网了解JetBrains出品的IDEs">
-    <img src="docs/jetbrains.svg" width="128" alt="JetBrains logo">
+    <img src="docs/static/jetbrains.svg" width="128" alt="JetBrains logo">
   </a>
 </p>
diff --git a/cmd/version.go b/cmd/version.go
@@ -15,18 +15,12 @@ var (
 	kubecmVersion = "unknown"
 	goos          = runtime.GOOS
 	goarch        = runtime.GOARCH
-	gitCommit     = "$Format:%H$"          // sha1 from git, output of $(git rev-parse HEAD)
-	buildDate     = "1970-01-01T00:00:00Z" // build date in ISO8601 format, output of $(date -u +'%Y-%m-%dT%H:%M:%SZ')
 )
 
 // version returns the version of kustomize.
 type version struct {
 	// KustomizeVersion is a kustomize binary version.
 	KubecmVersion string `json:"kubecmVersion"`
-	// GitCommit is a git commit
-	GitCommit string `json:"gitCommit"`
-	// BuildDate is a build date of the binary.
-	BuildDate string `json:"buildDate"`
 	// GoOs holds OS name.
 	GoOs string `json:"goOs"`
 	// GoArch holds architecture name.
@@ -42,8 +36,6 @@ func (vc *VersionCommand) Init() {
 		Aliases: []string{"v"},
 		Run: func(cmd *cobra.Command, args []string) {
 			cmd.Printf("Version: %s\n", getVersion().KubecmVersion)
-			cmd.Printf("GitCommit: %s\n", getVersion().GitCommit)
-			cmd.Printf("BuildDate: %s\n", getVersion().BuildDate)
 			cmd.Printf("GoOs: %s\n", getVersion().GoOs)
 			cmd.Printf("GoArch: %s\n", getVersion().GoArch)
 		},
@@ -54,8 +46,6 @@ func (vc *VersionCommand) Init() {
 func getVersion() version {
 	return version{
 		kubecmVersion,
-		gitCommit,
-		buildDate,
 		goos,
 		goarch,
 	}

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/CNAME b/docs/CNAME
@@ -0,0 +1 @@
+kubecm.cloud
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,64 @@
+# KubeCM
+
+![Go](https://github.com/sunny0826/kubecm/workflows/Go/badge.svg?branch=master)
+[![Go Report Card](https://goreportcard.com/badge/github.com/sunny0826/kubecm)](https://goreportcard.com/report/github.com/sunny0826/kubecm)
+![GitHub](https://img.shields.io/github/license/sunny0826/kubecm.svg)
+[![GitHub release](https://img.shields.io/github/release/sunny0826/kubecm)](https://github.com/sunny0826/kubecm/releases)
+[![codecov](https://codecov.io/gh/sunny0826/kubecm/branch/master/graph/badge.svg?token=KGTLBQ8HYZ)](undefined)
+
+```text
+KubeConfig Manager
+ _          _
+| | ___   _| |__   ___  ___ _ __ ___
+| |/ / | | | '_ \ / _ \/ __| '_ \ _ \
+|   <| |_| | |_) |  __/ (__| | | | | |
+|_|\_\\__,_|_.__/ \___|\___|_| |_| |_|
+
+Find more information at: https://github.com/sunny0826/kubecm
+
+Usage:
+  kubecm [flags]
+  kubecm [command]
+
+Available Commands:
+    add         Merge configuration file with $HOME/.kube/config
+    alias       Generate alias for all contexts
+    completion  Generates bash/zsh completion scripts
+    delete      Delete the specified context from the kubeconfig
+    help        Help about any command
+    ls          List kubeconfig
+    merge       Merge the kubeconfig files in the specified directory
+    namespace   Switch or change namespace interactively
+    rename      Rename the contexts of kubeconfig
+    switch      Switch Kube Context interactively
+    version     Print version info
+
+
+Flags:
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
+  -h, --help   help for kubecm
+
+Use "kubecm [command] --help" for more information about a command.
+```
+
+## Documentation
+
+For full documentation, please visit the KubeVela website: [https://kubecm.cloud](https://kubecm.cloud)
+
+## Video
+
+[![](https://tva3.sinaimg.cn/large/ad5fbf65gy1gij1pl0pn5j218o0p81kx.jpg)](https://www.bilibili.com/video/av88259938/)
+
+## Contribute
+
+Feel free to open issues and pull requests. Any feedback is highly appreciated!
+
+## Thanks
+
+- [JetBrains IDEs](https://www.jetbrains.com/?from=kubecm)
+
+<p align="center">
+  <a href="https://www.jetbrains.com/?from=kubecm" title="前往官网了解JetBrains出品的IDEs">
+    <img src="docs/static/jetbrains.svg" width="128" alt="JetBrains logo">
+  </a>
+</p>