Add docs generator and initial docs

astronomer · Jun 29, 2018 · 39b3351 · 39b3351
1 parent 4146d4a
commit 39b3351
Show file tree

Hide file tree

Showing 23 changed files with 665 additions and 0 deletions.
diff --git a/docs/astro.md b/docs/astro.md
@@ -0,0 +1,25 @@
+## astro
+
+Astronomer - CLI
+
+### Synopsis
+
+astro is a command line interface for working with the Astronomer Platform.
+
+### Options
+
+```
+  -g, --global   view or modify global config
+  -h, --help     help for astro
+```
+
+### SEE ALSO
+
+* [astro airflow]({{< relref "docs/astro_airflow.md" >}})	 - Manage airflow projects and deployments
+* [astro auth]({{< relref "docs/astro_auth.md" >}})	 - Mangage astronomer identity
+* [astro config]({{< relref "docs/astro_config.md" >}})	 - Manage astro project configurations
+* [astro upgrade]({{< relref "docs/astro_upgrade.md" >}})	 - Check for newer version of Astronomer CLI
+* [astro users]({{< relref "docs/astro_users.md" >}})	 - Manage astronomer users
+* [astro version]({{< relref "docs/astro_version.md" >}})	 - Astronomer CLI version
+
+###### Auto generated by spf13/cobra on 29-Jun-2018
diff --git a/docs/astro_airflow.md b/docs/astro_airflow.md
@@ -0,0 +1,33 @@
+## astro airflow
+
+Manage airflow projects and deployments
+
+### Synopsis
+
+Manage airflow projects and deployments
+
+### Options
+
+```
+  -h, --help   help for airflow
+```
+
+### Options inherited from parent commands
+
+```
+  -g, --global   view or modify global config
+```
+
+### SEE ALSO
+
+* [astro]({{< relref "docs/astro.md" >}})	 - Astronomer - CLI
+* [astro airflow create]({{< relref "docs/astro_airflow_create.md" >}})	 - Create a new airflow deployment
+* [astro airflow deploy]({{< relref "docs/astro_airflow_deploy.md" >}})	 - Deploy an airflow project
+* [astro airflow init]({{< relref "docs/astro_airflow_init.md" >}})	 - Scaffold a new airflow project
+* [astro airflow kill]({{< relref "docs/astro_airflow_kill.md" >}})	 - Kill a development airflow cluster
+* [astro airflow list]({{< relref "docs/astro_airflow_list.md" >}})	 - List airflow clusters
+* [astro airflow ps]({{< relref "docs/astro_airflow_ps.md" >}})	 - List airflow containers
+* [astro airflow start]({{< relref "docs/astro_airflow_start.md" >}})	 - Start a development airflow cluster
+* [astro airflow stop]({{< relref "docs/astro_airflow_stop.md" >}})	 - Stop a development airflow cluster
+
+###### Auto generated by spf13/cobra on 29-Jun-2018
diff --git a/docs/astro_airflow_create.md b/docs/astro_airflow_create.md
@@ -0,0 +1,29 @@
+## astro airflow create
+
+Create a new airflow deployment
+
+### Synopsis
+
+Create a new airflow deployment
+
+```
+astro airflow create [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for create
+```
+
+### Options inherited from parent commands
+
+```
+  -g, --global   view or modify global config
+```
+
+### SEE ALSO
+
+* [astro airflow]({{< relref "docs/astro_airflow.md" >}})	 - Manage airflow projects and deployments
+
+###### Auto generated by spf13/cobra on 29-Jun-2018
diff --git a/docs/astro_airflow_deploy.md b/docs/astro_airflow_deploy.md
@@ -0,0 +1,30 @@
+## astro airflow deploy
+
+Deploy an airflow project
+
+### Synopsis
+
+Deploy an airflow project to a given deployment
+
+```
+astro airflow deploy [flags]
+```
+
+### Options
+
+```
+  -f, --force   Force deploy if uncommited changes
+  -h, --help    help for deploy
+```
+
+### Options inherited from parent commands
+
+```
+  -g, --global   view or modify global config
+```
+
+### SEE ALSO
+
+* [astro airflow]({{< relref "docs/astro_airflow.md" >}})	 - Manage airflow projects and deployments
+
+###### Auto generated by spf13/cobra on 29-Jun-2018
diff --git a/docs/astro_airflow_init.md b/docs/astro_airflow_init.md
@@ -0,0 +1,30 @@
+## astro airflow init
+
+Scaffold a new airflow project
+
+### Synopsis
+
+Scaffold a new airflow project
+
+```
+astro airflow init [flags]
+```
+
+### Options
+
+```
+  -h, --help          help for init
+  -n, --name string   Name of airflow project
+```
+
+### Options inherited from parent commands
+
+```
+  -g, --global   view or modify global config
+```
+
+### SEE ALSO
+
+* [astro airflow]({{< relref "docs/astro_airflow.md" >}})	 - Manage airflow projects and deployments
+
+###### Auto generated by spf13/cobra on 29-Jun-2018
diff --git a/docs/astro_airflow_kill.md b/docs/astro_airflow_kill.md
@@ -0,0 +1,29 @@
+## astro airflow kill
+
+Kill a development airflow cluster
+
+### Synopsis
+
+Kill a development airflow cluster
+
+```
+astro airflow kill [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for kill
+```
+
+### Options inherited from parent commands
+
+```
+  -g, --global   view or modify global config
+```
+
+### SEE ALSO
+
+* [astro airflow]({{< relref "docs/astro_airflow.md" >}})	 - Manage airflow projects and deployments
+
+###### Auto generated by spf13/cobra on 29-Jun-2018
diff --git a/docs/astro_airflow_list.md b/docs/astro_airflow_list.md
@@ -0,0 +1,29 @@
+## astro airflow list
+
+List airflow clusters
+
+### Synopsis
+
+List all created airflow clusters
+
+```
+astro airflow list [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for list
+```
+
+### Options inherited from parent commands
+
+```
+  -g, --global   view or modify global config
+```
+
+### SEE ALSO
+
+* [astro airflow]({{< relref "docs/astro_airflow.md" >}})	 - Manage airflow projects and deployments
+
+###### Auto generated by spf13/cobra on 29-Jun-2018
diff --git a/docs/astro_airflow_ps.md b/docs/astro_airflow_ps.md
@@ -0,0 +1,29 @@
+## astro airflow ps
+
+List airflow containers
+
+### Synopsis
+
+List airflow containers
+
+```
+astro airflow ps [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for ps
+```
+
+### Options inherited from parent commands
+
+```
+  -g, --global   view or modify global config
+```
+
+### SEE ALSO
+
+* [astro airflow]({{< relref "docs/astro_airflow.md" >}})	 - Manage airflow projects and deployments
+
+###### Auto generated by spf13/cobra on 29-Jun-2018
diff --git a/docs/astro_airflow_start.md b/docs/astro_airflow_start.md
@@ -0,0 +1,29 @@
+## astro airflow start
+
+Start a development airflow cluster
+
+### Synopsis
+
+Start a development airflow cluster
+
+```
+astro airflow start [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for start
+```
+
+### Options inherited from parent commands
+
+```
+  -g, --global   view or modify global config
+```
+
+### SEE ALSO
+
+* [astro airflow]({{< relref "docs/astro_airflow.md" >}})	 - Manage airflow projects and deployments
+
+###### Auto generated by spf13/cobra on 29-Jun-2018
diff --git a/docs/astro_airflow_stop.md b/docs/astro_airflow_stop.md
@@ -0,0 +1,29 @@
+## astro airflow stop
+
+Stop a development airflow cluster
+
+### Synopsis
+
+Stop a development airflow cluster
+
+```
+astro airflow stop [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for stop
+```
+
+### Options inherited from parent commands
+
+```
+  -g, --global   view or modify global config
+```
+
+### SEE ALSO
+
+* [astro airflow]({{< relref "docs/astro_airflow.md" >}})	 - Manage airflow projects and deployments
+
+###### Auto generated by spf13/cobra on 29-Jun-2018
diff --git a/docs/astro_auth.md b/docs/astro_auth.md
@@ -0,0 +1,27 @@
+## astro auth
+
+Mangage astronomer identity
+
+### Synopsis
+
+Manage astronomer identity
+
+### Options
+
+```
+  -h, --help   help for auth
+```
+
+### Options inherited from parent commands
+
+```
+  -g, --global   view or modify global config
+```
+
+### SEE ALSO
+
+* [astro]({{< relref "docs/astro.md" >}})	 - Astronomer - CLI
+* [astro auth login]({{< relref "docs/astro_auth_login.md" >}})	 - Login to Astronomer services
+* [astro auth logout]({{< relref "docs/astro_auth_logout.md" >}})	 - Logout of Astronomer services
+
+###### Auto generated by spf13/cobra on 29-Jun-2018
diff --git a/docs/astro_auth_login.md b/docs/astro_auth_login.md
@@ -0,0 +1,31 @@
+## astro auth login
+
+Login to Astronomer services
+
+### Synopsis
+
+Login to Astronomer services
+
+```
+astro auth login [flags]
+```
+
+### Options
+
+```
+  -d, --domain string     pass the cluster domain for authentication
+  -h, --help              help for login
+  -r, --registry string   pass a custom project registry for authentication
+```
+
+### Options inherited from parent commands
+
+```
+  -g, --global   view or modify global config
+```
+
+### SEE ALSO
+
+* [astro auth]({{< relref "docs/astro_auth.md" >}})	 - Mangage astronomer identity
+
+###### Auto generated by spf13/cobra on 29-Jun-2018
diff --git a/docs/astro_auth_logout.md b/docs/astro_auth_logout.md
@@ -0,0 +1,29 @@
+## astro auth logout
+
+Logout of Astronomer services
+
+### Synopsis
+
+Logout of Astronomer services
+
+```
+astro auth logout [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for logout
+```
+
+### Options inherited from parent commands
+
+```
+  -g, --global   view or modify global config
+```
+
+### SEE ALSO
+
+* [astro auth]({{< relref "docs/astro_auth.md" >}})	 - Mangage astronomer identity
+
+###### Auto generated by spf13/cobra on 29-Jun-2018