include to exported docs child commands

Author: fabriciojs

docs.go

@@ -5,6 +5,7 @@ package main
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"kool-dev/kool/commands"
 	"kool-dev/kool/core/shell"
@@ -14,22 +15,17 @@ import (
 	"regexp"
 	"strings"
 
+	"github.com/spf13/cobra"
 	"github.com/spf13/cobra/doc"
 )
 
 func main() {
 	var (
 		err        error
 		koolOutput *bytes.Buffer
-		cmdFile    *os.File
 		koolFile   *os.File
 	)
 
-	linkHandler := func(filename string) string {
-		base := strings.TrimSuffix(filename, filepath.Ext(filename))
-		return strings.ToLower(base)
-	}
-
 	fmt.Println("Going to generate cobra docs in markdown...")
 
 	koolOutput = new(bytes.Buffer)
@@ -43,35 +39,12 @@ func main() {
 	koolMarkdown := koolOutput.String()
 
 	for _, childCmd := range commands.RootCmd().Commands() {
-		var cmdName string
-
-		if cmdName = strings.Replace(childCmd.CommandPath(), " ", "_", -1); cmdName == "kool_deploy" || cmdName == "kool_help" {
-			continue
-		}
-
-		newName := strings.Replace(childCmd.CommandPath(), " ", "-", -1)
-		koolMarkdown = strings.Replace(koolMarkdown, cmdName, newName, -1)
-
-		cmdOutput := new(bytes.Buffer)
-
-		err = doc.GenMarkdownCustom(childCmd, cmdOutput, linkHandler)
-
-		if err != nil {
-			log.Fatal(err)
-		}
-
-		cmdFile, err = CreateFile(newName, "docs/4-Commands")
-
-		if err != nil {
-			log.Fatal(err)
-		}
-
-		defer cmdFile.Close()
-
-		_, err = cmdOutput.WriteTo(cmdFile)
-
-		if err != nil {
-			log.Fatal(err)
+		if err = exportCmdDocs(childCmd, &koolMarkdown); err != nil {
+			if strings.HasPrefix(err.Error(), "skip") {
+				log.Println(err)
+			} else {
+				log.Fatal(err)
+			}
 		}
 	}
 
@@ -106,3 +79,51 @@ func CreateFile(filename string, dir string) (file *os.File, err error) {
 
 	return
 }
+
+func exportCmdDocs(childCmd *cobra.Command, koolMarkdown *string) (err error) {
+	var (
+		cmdName string
+		cmdFile *os.File
+	)
+
+	if cmdName = strings.Replace(childCmd.CommandPath(), " ", "_", -1); cmdName == "kool_help" {
+		err = errors.New("skip kool_help")
+		return
+	}
+
+	newName := strings.Replace(childCmd.CommandPath(), " ", "-", -1)
+	*koolMarkdown = strings.Replace(*koolMarkdown, cmdName, newName, -1)
+
+	cmdOutput := new(bytes.Buffer)
+
+	if err = doc.GenMarkdownCustom(childCmd, cmdOutput, linkHandler); err != nil {
+		return
+	}
+
+	if cmdFile, err = CreateFile(newName, "docs/4-Commands"); err != nil {
+		return
+	}
+
+	defer cmdFile.Close()
+
+	if _, err = cmdOutput.WriteTo(cmdFile); err != nil {
+		return
+	}
+
+	for _, subCmd := range childCmd.Commands() {
+		if err = exportCmdDocs(subCmd, koolMarkdown); err != nil {
+			if strings.HasPrefix(err.Error(), "skip") {
+				log.Println(err)
+			} else {
+				return
+			}
+		}
+	}
+
+	return
+}
+
+func linkHandler(filename string) string {
+	base := strings.TrimSuffix(filename, filepath.Ext(filename))
+	return strings.ToLower(base)
+}

docs/3-Deploy-to-Kool-Cloud/1-Getting-Started.md

@@ -1,26 +1,30 @@
-The Kool Cloud supports a wide range of features designed to suit your needs for deploying dockerized web applications. It supports features such as persisting folders across deployments, running daemons as extra containers, scheduling commands like cron jobs, adding hooks for before and after deployment, viewing running container logs, accessing the running container interactively, and much more.
+The [Kool Cloud](https://kool.dev/cloud) supports a wide range of features designed to suit your needs for deploying containerized web applications. It supports features such as **persisting folders** across deployments, running **daemons** as extra containers, scheduling commands like **cron jobs**, adding **hooks to run before or after** deployment, **viewing logs** of running container, accessing the running container **interactively**, and much more.
 
-The Deploy API was designed with the best developer experience in mind for deploying containers to the cloud. By leveraging your existing local environment structure in `docker-compose.yml` and adding a sane and intuitive configuration layer that will feel familiar from the first contact, our goal is to provide a best-in-class offering for cloud platform engineering. This platform allows you to leverage Kubernetes and orchestrate your web applications in the cloud without all the hassle.
+The Kool.dev Cloud API was designed with the best developer experience in mind for deploying containers to the cloud. By leveraging your existing local environment structure in `docker-compose.yml` and adding a sane and intuitive configuration layer that will feel familiar from the first sight, our goal is to provide a best-in-class offering for cloud platform engineering. This platform allows you to leverage Kubernetes and orchestrate your web applications in the cloud without all the hassle.
 
-**kool cloud** is a CLI suite of commands that allows you to configure, deploy, access, and tail logs from the applications to Kool Cloud via the Deploy API.
+> **Enterprise**: you can use Kool.dev Cloud to deploy workloads to your own cloud vendor to keep things compliant - [contact us](mailto:[email protected]) for **"Bring your Own Cloud"** offer.
+
+**kool cloud** is the CLI suite of commands that allows you to configure, deploy, access, and tail logs from the applications to the cloud via the Kool.dev Cloud API.
 
 ## Deploy Docker Compose-based, containerized apps in just a few simple steps
 
-1. Sign up for Kool Cloud and get your access token.
-	- Make sure your `.env` file contains two entries for configuring your deployment:
-		- `KOOL_API_TOKEN` - the Deploy API access token you get from the kool.dev web panel.
-1. Configure your deployment with files straight in your application root folder
-	- `kool.deploy.yml` - a "mirror" of your `docker-compose.yml` file, with extra pieces of data for your cloud deployment.
+1. [Sign up for Kool Cloud](https://kool.dev/register) and get your access token.
+	- You can store your token in your `.env` file if you are using one:
+		- `echo "KOOL_API_TOKEN=<my-token>" >> .env`
+	- Or you can store your token in a real environment variable:
+		- `export KOOL_API_TOKEN="<my token>"`
+1. Configure your deployment with files directly in your application root folder. For that you can use [`kool cloud setup`](TODO:cloud-setup) to help guide you creating the following files:
+	- `kool.deploy.yml` - a "mirror" of your `docker-compose.yml` file, with extra pieces of data for customizing your cloud deployment.
 	- `Dockerfile` - usually, you are going to need to build your app for deployment if you haven't already.
-	- Make sure you set up the necessary environment variables for your app to run in the cloud.
+	- Make sure you set up the necessary [environment variables](TODO:envs) for your app to run in the cloud.
 1. Deploy your application
-	- Run `kool cloud deploy` - this will validate and deploy your application.
+	- Run `kool cloud deploy --domain=<your domain>` - this will validate and deploy your application.
 	- Wait for it to finish and then access the provided deployment URL!
 1. Doing more
 	- **View logs**
 		- `kool cloud logs` - you can check the logs of your deployed containers.
-	- **Access cloud containers**
-		- `kool cloud exec` - you can execute commands, including interactive TTY sessions, within your cloud-deployed containers.
+	- **Access running containers (like SSH-ing in)**
+		- `kool cloud exec` - you can execute commands, including interactive TTY sessions, within your cloud-deployed containers. For example: `kool cloud exec app bash` to open a bash in my running container in the cloud.
 
 ---
 

docs/4-Commands/kool-cloud-deploy.md

@@ -0,0 +1,30 @@
+## kool cloud deploy
+
+Deploy a local application to a Kool Cloud environment
+
+```
+kool cloud deploy
+```
+
+### Options
+
+```
+      --domain-extra stringArray   List of extra domain aliases
+  -h, --help                       help for deploy
+      --timeout uint               Timeout in minutes for waiting the deployment to finish
+      --www-redirect               Redirect www to non-www domain
+```
+
+### Options inherited from parent commands
+
+```
+      --domain string        Environment domain name to deploy to
+      --token string         Token to authenticate with Kool Cloud API
+      --verbose              Increases output verbosity
+  -w, --working_dir string   Changes the working directory for the command
+```
+
+### SEE ALSO
+
+* [kool cloud](kool_cloud)	 - Interact with Kool Cloud and manage your deployments.
+

docs/4-Commands/kool-cloud-destroy.md

@@ -0,0 +1,27 @@
+## kool cloud destroy
+
+Destroy an environment deployed to Kool Cloud
+
+```
+kool cloud destroy
+```
+
+### Options
+
+```
+  -h, --help   help for destroy
+```
+
+### Options inherited from parent commands
+
+```
+      --domain string        Environment domain name to deploy to
+      --token string         Token to authenticate with Kool Cloud API
+      --verbose              Increases output verbosity
+  -w, --working_dir string   Changes the working directory for the command
+```
+
+### SEE ALSO
+
+* [kool cloud](kool_cloud)	 - Interact with Kool Cloud and manage your deployments.
+

docs/4-Commands/kool-cloud-exec.md

@@ -0,0 +1,34 @@
+## kool cloud exec
+
+Execute a command inside a running service container deployed to Kool Cloud
+
+### Synopsis
+
+After deploying an application to Kool Cloud using 'kool deploy',
+execute a COMMAND inside the specified SERVICE container (similar to an SSH session).
+Must use a KOOL_API_TOKEN environment variable for authentication.
+
+```
+kool cloud exec SERVICE [COMMAND] [--] [ARG...]
+```
+
+### Options
+
+```
+  -c, --container string   Container target. (default "default")
+  -h, --help               help for exec
+```
+
+### Options inherited from parent commands
+
+```
+      --domain string        Environment domain name to deploy to
+      --token string         Token to authenticate with Kool Cloud API
+      --verbose              Increases output verbosity
+  -w, --working_dir string   Changes the working directory for the command
+```
+
+### SEE ALSO
+
+* [kool cloud](kool_cloud)	 - Interact with Kool Cloud and manage your deployments.
+

docs/4-Commands/kool-cloud-help.md

@@ -0,0 +1,32 @@
+## kool cloud help
+
+Help about any command
+
+### Synopsis
+
+Help provides help for any command in the application.
+Simply type cloud help [path to command] for full details.
+
+```
+kool cloud help [command] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for help
+```
+
+### Options inherited from parent commands
+
+```
+      --domain string        Environment domain name to deploy to
+      --token string         Token to authenticate with Kool Cloud API
+      --verbose              Increases output verbosity
+  -w, --working_dir string   Changes the working directory for the command
+```
+
+### SEE ALSO
+
+* [kool cloud](kool_cloud)	 - Interact with Kool Cloud and manage your deployments.
+

docs/4-Commands/kool-cloud-logs.md

@@ -0,0 +1,36 @@
+## kool cloud logs
+
+See the logs of running service container deployed to Kool Cloud
+
+### Synopsis
+
+After deploying an application to Kool Cloud using 'kool deploy',
+you can see the logs from the specified SERVICE container.
+Must use a KOOL_API_TOKEN environment variable for authentication.
+
+```
+kool cloud logs [OPTIONS] SERVICE
+```
+
+### Options
+
+```
+  -c, --container string   Container target. (default "default")
+  -f, --follow             Follow log output.
+  -h, --help               help for logs
+  -t, --tail int           Number of lines to show from the end of the logs for each container. A value equal to 0 will show all lines. (default 25)
+```
+
+### Options inherited from parent commands
+
+```
+      --domain string        Environment domain name to deploy to
+      --token string         Token to authenticate with Kool Cloud API
+      --verbose              Increases output verbosity
+  -w, --working_dir string   Changes the working directory for the command
+```
+
+### SEE ALSO
+
+* [kool cloud](kool_cloud)	 - Interact with Kool Cloud and manage your deployments.
+

docs/4-Commands/kool-cloud-setup.md

@@ -0,0 +1,27 @@
+## kool cloud setup
+
+Set up local configuration files for deployment
+
+```
+kool cloud setup
+```
+
+### Options
+
+```
+  -h, --help   help for setup
+```
+
+### Options inherited from parent commands
+
+```
+      --domain string        Environment domain name to deploy to
+      --token string         Token to authenticate with Kool Cloud API
+      --verbose              Increases output verbosity
+  -w, --working_dir string   Changes the working directory for the command
+```
+
+### SEE ALSO
+
+* [kool cloud](kool_cloud)	 - Interact with Kool Cloud and manage your deployments.
+