Adding examples

Signed-off-by: ytimocin <ytimocin@microsoft.com>

README.md

@@ -25,6 +25,7 @@ With features like interactive flows, intelligent suggestions, and broad connect
   - [🎯 Planned Features](#-planned-features)
   - [🤝 Contributing](#-contributing)
   - [🪪 License](#-license)
+  - [📚 Examples](#-examples)
 
 ## 🚀 Key Features
 
@@ -139,3 +140,7 @@ We welcome contributions! Please see our [CONTRIBUTING.md](docs/contributing/CON
 ## 🪪 License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 📚 Examples
+
+Please see [Prompt-Ops examples](docs/examples/README.md) for details.

cmd/pops/app/conn/cloud/cloud.go

@@ -14,11 +14,11 @@ Cloud Connection:
 - Available Cloud connection types: Azure.
 - Commands: create, delete, open, list, types.
 - Examples:
- * 'pops connection cloud create' creates a connection to a cloud provider.
- * 'pops connection cloud open' opens an existing cloud connection.
- * 'pops connection cloud list' lists all cloud connections.
- * 'pops connection cloud delete' deletes a cloud connection.
- * 'pops connection cloud types' lists all available cloud connection types (for now; Azure).
+ * 'pops conn cloud create' creates a connection to a cloud provider.
+ * 'pops conn cloud open' opens an existing cloud connection.
+ * 'pops conn cloud list' lists all cloud connections.
+ * 'pops conn cloud delete' deletes a cloud connection.
+ * 'pops conn cloud types' lists all available cloud connection types (for now; Azure).
 
 More connection types and features are coming soon!`,
 	}

cmd/pops/app/conn/cloud/create.go

@@ -61,8 +61,8 @@ Cloud Connection:
 - Available Cloud connection types: Azure.
 - Commands: create, delete, open, list, types.
 - Examples:
- * 'pops connection cloud create' creates a connection interactively.
- * 'pops connection cloud create --name my-azure-conn --provider azure' creates a connection non-interactively.
+ * 'pops conn cloud create' creates a connection interactively.
+ * 'pops conn cloud create --name my-azure-conn --provider azure' creates a connection non-interactively.
 `,
 		Run: func(cmd *cobra.Command, args []string) {
 			// Non-interactive mode

cmd/pops/app/conn/db/db.go

@@ -14,11 +14,11 @@ Database Connection:
 - Available Database connection types: MySQL, PostgreSQL, and MongoDB.
 - Commands: create, delete, open, list, types.
 - Examples:
- * 'pops connection db create' creates a connection to a database.
- * 'pops connection db open' opens an existing database connection.
- * 'pops connection db list' lists all database connections.
- * 'pops connection db delete' deletes a database connection.
- * 'pops connection db types' lists all available database connection types (for now; MySQL, PostgreSQL, and MongoDB).
+ * 'pops conn db create' creates a connection to a database.
+ * 'pops conn db open' opens an existing database connection.
+ * 'pops conn db list' lists all database connections.
+ * 'pops conn db delete' deletes a database connection.
+ * 'pops conn db types' lists all available database connection types (for now; MySQL, PostgreSQL, and MongoDB).
 
 More connection types and features are coming soon!`,
 	}

cmd/pops/app/conn/k8s/kubernetes.go

@@ -6,19 +6,20 @@ import (
 
 func NewRootCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "kubernetes",
-		Short: "Manage kubernetes connections.",
+		Use:     "kubernetes",
+		Aliases: []string{"k8s"},
+		Short:   "Manage kubernetes connections.",
 		Long: `
 Kubernetes Connection:
 
 - Available Kubernetes connection types: All Kubernetes clusters defined in your configuration.
 - Commands: create, delete, open, list, types.
 - Examples:
- * 'pops connection kubernetes create' creates a connection to a Kubernetes cluster.
- * 'pops connection kubernetes open' opens an existing Kubernetes connection.
- * 'pops connection kubernetes list' lists all Kubernetes connections.
- * 'pops connection kubernetes delete' deletes a Kubernetes connection.
- * 'pops connection kubernetes types' lists all available Kubernetes connection types (for now; all Kubernetes clusters defined in your configuration).
+ * 'pops conn k8s create' creates a connection to a Kubernetes cluster.
+ * 'pops conn k8s open' opens an existing Kubernetes connection.
+ * 'pops conn k8s list' lists all Kubernetes connections.
+ * 'pops conn k8s delete' deletes a Kubernetes connection.
+ * 'pops conn k8s types' lists all available Kubernetes connection types (for now; all Kubernetes clusters defined in your configuration).
 
 More connection types and features are coming soon!`,
 	}

docs/examples/README.md

@@ -0,0 +1,7 @@
+# Prompt-Ops Examples
+
+## Connection Examples
+
+### Kubernetes
+
+- [`pops conn k8s create` example](conn/k8s/README.md)

docs/examples/conn/k8s/README.md

@@ -0,0 +1,19 @@
+# Prompt-Ops Kubernetes Connection Examples
+
+## Create a new Connection
+
+To create a new Kubernetes connection, use the following command:
+
+```bash
+pops conn k8s create
+```
+
+Demo:
+
+![pops conn k8s create](./pops_conn_k8s_create_v1.gif)
+
+## Open an existing Connection
+
+## Ask a Question via Prompt-Ops
+
+## Request a Command via Prompt-Ops