Add tutorial field to config.json files (#253)

Signed-off-by: Everest <[email protected]>
ZupIT · Oct 2, 2020 · 1929c42 · 1929c42
1 parent 55a38d3
commit 1929c42
Show file tree

Hide file tree

Showing 45 changed files with 279 additions and 149 deletions.
diff --git a/aws/add/terraform-eks/config.json b/aws/add/terraform-eks/config.json
@@ -4,12 +4,14 @@
     {
       "label": "Type the cluster name:",
       "name": "cluster_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Your EKS cluster name"
     },
     {
       "label": "Type the domain name:",
       "name": "domain_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Your EKS domain name"
     }
   ]
 }
diff --git a/aws/add/terraform-vpc/config.json b/aws/add/terraform-vpc/config.json
@@ -28,27 +28,32 @@
       ],
       "label": "Pick the region: ",
       "name": "region",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Choose one option"
     },
     {
       "label": "Type the vpc name:",
       "name": "vpc_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "The vpc name e.g.: some-vpc"
     },
     {
-      "label": "Type the vpc_cidr [e.g.: 10.0.0.0/16]:",
+      "label": "Type the vpc_cidr:",
       "name": "vpc_cidr",
-      "type": "text"
+      "type": "text",
+      "tutorial": "The vpc cidr e.g.: 10.0.0.0/16"
     },
     {
-      "label": "Type your vpc_azs [e.g.: us-west-1a, us-west-1c]:",
+      "label": "Type your vpc_azs:",
       "name": "vpc_azs",
-      "type": "text"
+      "type": "text",
+      "tutorial": "AWS vpc_azs i.e., us-west-1a, us-west-1c"
     },
     {
       "label": "Type the customer name:",
       "name": "customer_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "A customer name e.g.: something"
     }
   ]
 }
diff --git a/aws/apply/terraform/config.json b/aws/apply/terraform/config.json
@@ -9,18 +9,21 @@
       ],
       "label": "Select your repository URL: ",
       "name": "repository",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Choose one option"
     },
     {
       "default": "src",
-      "label": "Type your terraform files path [src]: ",
+      "label": "Type your terraform files path: ",
       "name": "terraform_path",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Terraform files path e.g.: src"
     },
     {
-      "label": "Type your environment name: [ex.: qa, prod]",
+      "label": "Type your environment name:",
       "name": "environment",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Environment name i.e., qa, prod"
     },
     {
       "name": "git_user",

diff --git a/aws/clean/bucket/config.json b/aws/clean/bucket/config.json
@@ -15,9 +15,10 @@
         "newLabel": "Type new value. ",
         "qty": 6
       },
-      "label": "Type your region [ e.g us-east-1 ]: ",
+      "label": "Type your region: ",
       "name": "region",
-      "type": "text"
+      "type": "text",
+      "tutorial": "AWS region i.e., us-east-1, us-west-1, sa-east-1"
     }
   ]
 }
diff --git a/aws/create/bucket/config.json b/aws/create/bucket/config.json
@@ -15,14 +15,16 @@
         "newLabel": "Type new value. ",
         "qty": 6
       },
-      "label": "Type your region [ e.g us-east-1 ]: ",
+      "label": "Type your region: ",
       "name": "region",
-      "type": "text"
+      "type": "text",
+      "tutorial": "AWS region i.e., us-east-1, us-west-1, sa-east-1"
     },
     {
       "label": "Type bucket name: ",
       "name": "bucket",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Bucket name e.g.: some-aws-bucket"
     }
   ]
 }
diff --git a/aws/delete/bucket/config.json b/aws/delete/bucket/config.json
@@ -15,9 +15,10 @@
         "newLabel": "Type new value. ",
         "qty": 6
       },
-      "label": "Type your region [ e.g us-east-1 ]: ",
+      "label": "Type your region: ",
       "name": "region",
-      "type": "text"
+      "type": "text",
+      "tutorial": "AWS region i.e., us-east-1, us-west-1, sa-east-1"
     }
   ]
 }
diff --git a/aws/generate/terraform-project/config.json b/aws/generate/terraform-project/config.json
@@ -4,22 +4,26 @@
     {
       "label": "Type the project name: ",
       "name": "project_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Project name e.g.: awesome-project"
     },
     {
-      "label": "Type the location (e.g.: /home/user/projects): ",
+      "label": "Type the location: ",
       "name": "project_location",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Project location e.g.: /home/user/projects"
     },
     {
       "label": "Type the terraform bucket name: ",
       "name": "bucket_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Bucket name e.g.: some-aws-bucket"
     },
     {
       "label": "Type the bucket region: ",
       "name": "bucket_region",
-      "type": "text"
+      "type": "text",
+      "tutorial": "AWS region i.e., us-east-1, us-west-1, sa-east-1"
     }
   ]
 }
diff --git a/aws/list/bucket/config.json b/aws/list/bucket/config.json
@@ -15,9 +15,10 @@
         "newLabel": "Type new value. ",
         "qty": 6
       },
-      "label": "Type your region [ e.g us-east-1 ]: ",
+      "label": "Type your region: ",
       "name": "region",
-      "type": "text"
+      "type": "text",
+      "tutorial": "AWS region i.e., us-east-1, us-west-1, sa-east-1"
     }
   ]
 }
diff --git a/aws/set/context/config.json b/aws/set/context/config.json
@@ -9,7 +9,8 @@
       },
       "label": "Which context you want to use : ",
       "name": "context_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Context i.e., default"
     }
   ]
 }
diff --git a/aws/update/kubeconfig/config.json b/aws/update/kubeconfig/config.json
@@ -38,7 +38,8 @@
       ],
       "label": "Pick the region: ",
       "name": "region",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Choose one option"
     },
     {
       "cache": {
@@ -48,7 +49,8 @@
       },
       "label": "Cluster Name: ",
       "name": "cluster_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Your EKS cluster name"
     }
   ]
 }
diff --git a/bitbucket/create/repo/config.json b/bitbucket/create/repo/config.json
@@ -4,12 +4,14 @@
     {
       "label": "Project name: ",
       "name": "project_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Your project name e.g.: awesome-project"
     },
     {
       "label": "Project description: ",
       "name": "project_description",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Your project description e.g.: some awesome description"
     },
     {
       "default": "false",
@@ -19,13 +21,15 @@
       ],
       "label": "Create a private repository?: ",
       "name": "private",
-      "type": "bool"
+      "type": "bool",
+      "tutorial": "Choose one option"
     },
     {
       "default": " ",
-      "label": "Workspace path (ex: /home/user/my-project)\n(Note: An empty value create a Bitbucket repo with just a README file): ",
+      "label": "Workspace path: ",
       "name": "workspace_path",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Your workspace path i.e., /home/user/my-project \n Note: An empty value create a Gitlab repo with just a README file"
     },
     {
       "name": "username",

diff --git a/bitbucket/delete/repo/config.json b/bitbucket/delete/repo/config.json
@@ -4,7 +4,8 @@
     {
       "label": "Bitbucket project name to delete: ",
       "name": "project_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "The project name that you want to delete e.g.: not-so-awesome-project"
     },
     {
       "name": "username",

diff --git a/circleci/add/env/config.json b/circleci/add/env/config.json
@@ -13,7 +13,8 @@
       },
       "label": "Type the repository owner: ",
       "name": "repo_owner",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Project owner i.e., yourname"
     },
     {
       "cache": {
@@ -23,17 +24,20 @@
       },
       "label": "Type repository name: ",
       "name": "repo_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Your target project repository i.e., awesome-project"
     },
     {
       "label": "Type the ENV name : ",
       "name": "env_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Pipeline environment variable name i.e., SOME_NOME"
     },
     {
       "label": "Type the ENV value : ",
       "name": "env_value",
-      "type": "password"
+      "type": "password",
+      "tutorial": "Pipeline environment variable value i.e., 1234"
     }
   ]
 }
diff --git a/circleci/follow/project/config.json b/circleci/follow/project/config.json
@@ -8,7 +8,8 @@
       ],
       "label": "Select your provider: ",
       "name": "provider",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Choose one option"
     },
     {
       "name": "token",
@@ -40,7 +41,8 @@
       },
       "label": "Enter the project name to follow: ",
       "name": "project",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Your target project repository i.e., awesome-project"
     }
   ]
 }
diff --git a/git/update/fork/config.json b/git/update/fork/config.json
@@ -10,7 +10,8 @@
       "default": "master",
       "label": "Select destination branch (default: master):",
       "name": "branch",
-      "type": "text"
+      "type": "text",
+      "tutorial": "A git branch i.e., master, some-branch, developer"
     },
     {
       "default": "false",
@@ -20,7 +21,8 @@
       ],
       "label": "Set upstream ? (only first time)",
       "name": "setupstream",
-      "type": "bool"
+      "type": "bool",
+      "tutorial": "Choose one option"
     },
     {
       "default": "false",
@@ -30,7 +32,8 @@
       ],
       "label": "Push after update ?",
       "name": "push",
-      "type": "bool"
+      "type": "bool",
+      "tutorial": "Choose one option"
     }
   ]
 }
diff --git a/github/add/collaborator/config.json b/github/add/collaborator/config.json
@@ -9,7 +9,8 @@
       },
       "label": "Type collaborator username: ",
       "name": "collaborator_user",
-      "type": "text"
+      "type": "text",
+      "tutorial": "A github username e.g.: someuserzup"
     },
     {
       "cache": {
@@ -19,7 +20,8 @@
       },
       "label": "Type repository name: ",
       "name": "repository_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Target repository name i.e., ritchie-formulas"
     },
     {
       "name": "owner_username",

diff --git a/github/create/repo/config.json b/github/create/repo/config.json
@@ -4,12 +4,14 @@
     {
       "label": "Project name: ",
       "name": "project_name",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Your project name e.g.: awesome-project"
     },
     {
       "label": "Project description: ",
       "name": "project_description",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Your project description e.g.: Some awesome description"
     },
     {
       "default": "false",
@@ -19,13 +21,15 @@
       ],
       "label": "Create a private repository?: ",
       "name": "private",
-      "type": "bool"
+      "type": "bool",
+      "tutorial": "Choose one option"
     },
     {
       "default": " ",
-      "label": "Workspace path (ex: /home/user/my-project)\n(Note: An empty value create a GitHub repo with just a README file): ",
+      "label": "Workspace path: ",
       "name": "workspace_path",
-      "type": "text"
+      "type": "text",
+      "tutorial": "Your workspace path i.e., /home/user/my-project \n Note: An empty value create a GitHub repo with just a README file"
     },
     {
       "name": "username",