hub docs update

tektoncd · Jan 25, 2022 · 7781060 · 7781060
1 parent 77ce126
commit 7781060
Show file tree

Hide file tree

Showing 30 changed files with 83 additions and 124 deletions.
diff --git a/docs/cmd/tkn_hub.md b/docs/cmd/tkn_hub.md
@@ -15,20 +15,18 @@ Interact with tekton hub
 ### Options
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
   -h, --help                help for hub
 ```
 
 ### SEE ALSO
 
 * [tkn](tkn.md)	 - CLI for tekton pipelines
-* [tkn hub check-upgrade](tkn_hub_check-upgrade.md)	 - Check for upgrades of resources if present
 * [tkn hub downgrade](tkn_hub_downgrade.md)	 - Downgrade an installed resource
 * [tkn hub get](tkn_hub_get.md)	 - Get resource manifest by its name, kind, catalog, and version
 * [tkn hub info](tkn_hub_info.md)	 - Display info of resource by its name, kind, catalog, and version
 * [tkn hub install](tkn_hub_install.md)	 - Install a resource from a catalog by its kind, name and version
 * [tkn hub reinstall](tkn_hub_reinstall.md)	 - Reinstall a resource by its kind and name
-* [tkn hub search](tkn_hub_search.md)	 - Search resource by a combination of name, kind, categories, platforms, and tags
+* [tkn hub search](tkn_hub_search.md)	 - Search resource by a combination of name, kind, and tags
 * [tkn hub upgrade](tkn_hub_upgrade.md)	 - Upgrade an installed resource
 
diff --git a/docs/cmd/tkn_hub_downgrade.md b/docs/cmd/tkn_hub_downgrade.md
@@ -25,8 +25,7 @@ Downgrade an installed resource
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
 ```
 
 ### SEE ALSO

diff --git a/docs/cmd/tkn_hub_downgrade_task.md b/docs/cmd/tkn_hub_downgrade_task.md
@@ -35,8 +35,7 @@ Downgrade a Task of name 'foo' to version '0.3':
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
   -c, --context string      Name of the kubeconfig context to use (default: kubectl config current-context)
   -k, --kubeconfig string   Kubectl config file (default: $HOME/.kube/config)
   -n, --namespace string    Namespace to use (default: from $KUBECONFIG)

diff --git a/docs/cmd/tkn_hub_get.md b/docs/cmd/tkn_hub_get.md
@@ -15,16 +15,15 @@ Get resource manifest by its name, kind, catalog, and version
 ### Options
 
 ```
-      --from string      Name of Catalog to which resource belongs to.
+      --from string      Name of Catalog to which resource belongs to. (default "tekton")
   -h, --help             help for get
       --version string   Version of Resource
 ```
 
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
 ```
 
 ### SEE ALSO

diff --git a/docs/cmd/tkn_hub_get_pipeline.md b/docs/cmd/tkn_hub_get_pipeline.md
@@ -35,9 +35,8 @@ Get a Pipeline of name 'foo' of version '0.3':
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
-      --from string         Name of Catalog to which resource belongs to.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
+      --from string         Name of Catalog to which resource belongs to. (default "tekton")
       --version string      Version of Resource
 ```
 

diff --git a/docs/cmd/tkn_hub_get_task.md b/docs/cmd/tkn_hub_get_task.md
@@ -36,9 +36,8 @@ Get a Task of name 'foo' of version '0.3':
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
-      --from string         Name of Catalog to which resource belongs to.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
+      --from string         Name of Catalog to which resource belongs to. (default "tekton")
       --version string      Version of Resource
 ```
 

diff --git a/docs/cmd/tkn_hub_info.md b/docs/cmd/tkn_hub_info.md
@@ -15,16 +15,15 @@ Display info of resource by its name, kind, catalog, and version
 ### Options
 
 ```
-      --from string      Name of Catalog to which resource belongs.
+      --from string      Name of Catalog to which resource belongs. (default "tekton")
   -h, --help             help for info
       --version string   Version of Resource
 ```
 
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
 ```
 
 ### SEE ALSO

diff --git a/docs/cmd/tkn_hub_info_task.md b/docs/cmd/tkn_hub_info_task.md
@@ -35,9 +35,8 @@ Display info of a Task of name 'foo' of version '0.3':
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
-      --from string         Name of Catalog to which resource belongs.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
+      --from string         Name of Catalog to which resource belongs. (default "tekton")
       --version string      Version of Resource
 ```
 

diff --git a/docs/cmd/tkn_hub_install.md b/docs/cmd/tkn_hub_install.md
@@ -26,8 +26,7 @@ Install a resource from a catalog by its kind, name and version
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
 ```
 
 ### SEE ALSO

diff --git a/docs/cmd/tkn_hub_install_task.md b/docs/cmd/tkn_hub_install_task.md
@@ -35,8 +35,7 @@ Install a Task of name 'foo' of version '0.3' from Catalog 'Tekton':
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
   -c, --context string      Name of the kubeconfig context to use (default: kubectl config current-context)
       --from string         Name of Catalog to which resource belongs. (default "tekton")
   -k, --kubeconfig string   Kubectl config file (default: $HOME/.kube/config)

diff --git a/docs/cmd/tkn_hub_reinstall.md b/docs/cmd/tkn_hub_reinstall.md
@@ -26,8 +26,7 @@ Reinstall a resource by its kind and name
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
 ```
 
 ### SEE ALSO

diff --git a/docs/cmd/tkn_hub_reinstall_task.md b/docs/cmd/tkn_hub_reinstall_task.md
@@ -35,8 +35,7 @@ Reinstall a Task of name 'foo' of version '0.3' from Catalog 'Tekton':
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
   -c, --context string      Name of the kubeconfig context to use (default: kubectl config current-context)
       --from string         Name of Catalog to which resource belongs. (default "tekton")
   -k, --kubeconfig string   Kubectl config file (default: $HOME/.kube/config)

diff --git a/docs/cmd/tkn_hub_search.md b/docs/cmd/tkn_hub_search.md
@@ -1,6 +1,6 @@
 ## tkn hub search
 
-Search resource by a combination of name, kind, categories, platforms, and tags
+Search resource by a combination of name, kind, and tags
 
 ### Usage
 
@@ -10,7 +10,7 @@ tkn hub search
 
 ### Synopsis
 
-Search resource by a combination of name, kind, categories, platforms, and tags
+Search resource by a combination of name, kind, and tags
 
 ### Examples
 
@@ -29,21 +29,18 @@ Search resources using tag 'cli':
 ### Options
 
 ```
-      --categories stringArray   Accepts a comma separated list of categories
-  -h, --help                     help for search
-      --kinds stringArray        Accepts a comma separated list of kinds
-  -l, --limit uint               Max number of resources to fetch
-      --match string             Accept type of search. 'exact' or 'contains'. (default "contains")
-  -o, --output string            Accepts output format: [table, json, wide] (default "table")
-      --platforms stringArray    Accepts a comma separated list of platforms
-      --tags stringArray         Accepts a comma separated list of tags
+  -h, --help                help for search
+      --kinds stringArray   Accepts a comma separated list of kinds
+  -l, --limit uint          Max number of resources to fetch
+      --match string        Accept type of search. 'exact' or 'contains'. (default "contains")
+  -o, --output string       Accepts output format: [table, json] (default "table")
+      --tags stringArray    Accepts a comma separated list of tags
 ```
 
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
 ```
 
 ### SEE ALSO

diff --git a/docs/cmd/tkn_hub_upgrade.md b/docs/cmd/tkn_hub_upgrade.md
@@ -25,8 +25,7 @@ Upgrade an installed resource
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
 ```
 
 ### SEE ALSO

diff --git a/docs/cmd/tkn_hub_upgrade_task.md b/docs/cmd/tkn_hub_upgrade_task.md
@@ -35,8 +35,7 @@ Upgrade a Task of name 'foo' to version '0.3':
 ### Options inherited from parent commands
 
 ```
-      --api-server string   Hub API Server URL (default 'https://api.hub.tekton.dev').
-                            URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'HUB_API_SERVER'.
+      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
   -c, --context string      Name of the kubeconfig context to use (default: kubectl config current-context)
   -k, --kubeconfig string   Kubectl config file (default: $HOME/.kube/config)
   -n, --namespace string    Namespace to use (default: from $KUBECONFIG)

diff --git a/docs/man/man1/tkn-hub-downgrade-task.1 b/docs/man/man1/tkn-hub-downgrade-task.1
@@ -26,10 +26,9 @@ Downgrade an installed Task by its name to a lower version
 
 .SH OPTIONS INHERITED FROM PARENT COMMANDS
 .PP
-\fB\-\-api\-server\fP=""
-    Hub API Server URL (default '
-\[la]https://api.hub.tekton.dev'\[ra]).
-URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'HUB\_API\_SERVER'.
+\fB\-\-api\-server\fP="
+\[la]https://api.hub.tekton.dev"\[ra]
+    Hub API Server URL
 
 .PP
 \fB\-c\fP, \fB\-\-context\fP=""

diff --git a/docs/man/man1/tkn-hub-downgrade.1 b/docs/man/man1/tkn-hub-downgrade.1
@@ -42,10 +42,9 @@ Downgrade an installed resource
 
 .SH OPTIONS INHERITED FROM PARENT COMMANDS
 .PP
-\fB\-\-api\-server\fP=""
-    Hub API Server URL (default '
-\[la]https://api.hub.tekton.dev'\[ra]).
-URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'HUB\_API\_SERVER'.
+\fB\-\-api\-server\fP="
+\[la]https://api.hub.tekton.dev"\[ra]
+    Hub API Server URL
 
 
 .SH SEE ALSO

diff --git a/docs/man/man1/tkn-hub-get-pipeline.1 b/docs/man/man1/tkn-hub-get-pipeline.1
@@ -26,13 +26,12 @@ Get Pipeline by name, catalog and version
 
 .SH OPTIONS INHERITED FROM PARENT COMMANDS
 .PP
-\fB\-\-api\-server\fP=""
-    Hub API Server URL (default '
-\[la]https://api.hub.tekton.dev'\[ra]).
-URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'HUB\_API\_SERVER'.
+\fB\-\-api\-server\fP="
+\[la]https://api.hub.tekton.dev"\[ra]
+    Hub API Server URL
 
 .PP
-\fB\-\-from\fP=""
+\fB\-\-from\fP="tekton"
     Name of Catalog to which resource belongs to.
 
 .PP

diff --git a/docs/man/man1/tkn-hub-get-task.1 b/docs/man/man1/tkn-hub-get-task.1
@@ -30,13 +30,12 @@ Get Task by name, catalog and version
 
 .SH OPTIONS INHERITED FROM PARENT COMMANDS
 .PP
-\fB\-\-api\-server\fP=""
-    Hub API Server URL (default '
-\[la]https://api.hub.tekton.dev'\[ra]).
-URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'HUB\_API\_SERVER'.
+\fB\-\-api\-server\fP="
+\[la]https://api.hub.tekton.dev"\[ra]
+    Hub API Server URL
 
 .PP
-\fB\-\-from\fP=""
+\fB\-\-from\fP="tekton"
     Name of Catalog to which resource belongs to.
 
 .PP

diff --git a/docs/man/man1/tkn-hub-get.1 b/docs/man/man1/tkn-hub-get.1
@@ -20,7 +20,7 @@ Get resource manifest by its name, kind, catalog, and version
 
 .SH OPTIONS
 .PP
-\fB\-\-from\fP=""
+\fB\-\-from\fP="tekton"
     Name of Catalog to which resource belongs to.
 
 .PP
@@ -34,10 +34,9 @@ Get resource manifest by its name, kind, catalog, and version
 
 .SH OPTIONS INHERITED FROM PARENT COMMANDS
 .PP
-\fB\-\-api\-server\fP=""
-    Hub API Server URL (default '
-\[la]https://api.hub.tekton.dev'\[ra]).
-URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'HUB\_API\_SERVER'.
+\fB\-\-api\-server\fP="
+\[la]https://api.hub.tekton.dev"\[ra]
+    Hub API Server URL
 
 
 .SH SEE ALSO

diff --git a/docs/man/man1/tkn-hub-info-task.1 b/docs/man/man1/tkn-hub-info-task.1
@@ -26,13 +26,12 @@ Display info of Task by its name, catalog and version
 
 .SH OPTIONS INHERITED FROM PARENT COMMANDS
 .PP
-\fB\-\-api\-server\fP=""
-    Hub API Server URL (default '
-\[la]https://api.hub.tekton.dev'\[ra]).
-URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'HUB\_API\_SERVER'.
+\fB\-\-api\-server\fP="
+\[la]https://api.hub.tekton.dev"\[ra]
+    Hub API Server URL
 
 .PP
-\fB\-\-from\fP=""
+\fB\-\-from\fP="tekton"
     Name of Catalog to which resource belongs.
 
 .PP

diff --git a/docs/man/man1/tkn-hub-info.1 b/docs/man/man1/tkn-hub-info.1
@@ -20,7 +20,7 @@ Display info of resource by its name, kind, catalog, and version
 
 .SH OPTIONS
 .PP
-\fB\-\-from\fP=""
+\fB\-\-from\fP="tekton"
     Name of Catalog to which resource belongs.
 
 .PP
@@ -34,10 +34,9 @@ Display info of resource by its name, kind, catalog, and version
 
 .SH OPTIONS INHERITED FROM PARENT COMMANDS
 .PP
-\fB\-\-api\-server\fP=""
-    Hub API Server URL (default '
-\[la]https://api.hub.tekton.dev'\[ra]).
-URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'HUB\_API\_SERVER'.
+\fB\-\-api\-server\fP="
+\[la]https://api.hub.tekton.dev"\[ra]
+    Hub API Server URL
 
 
 .SH SEE ALSO

diff --git a/docs/man/man1/tkn-hub-install-task.1 b/docs/man/man1/tkn-hub-install-task.1
@@ -26,10 +26,9 @@ Install Task from a catalog by its name and version
 
 .SH OPTIONS INHERITED FROM PARENT COMMANDS
 .PP
-\fB\-\-api\-server\fP=""
-    Hub API Server URL (default '
-\[la]https://api.hub.tekton.dev'\[ra]).
-URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'HUB\_API\_SERVER'.
+\fB\-\-api\-server\fP="
+\[la]https://api.hub.tekton.dev"\[ra]
+    Hub API Server URL
 
 .PP
 \fB\-c\fP, \fB\-\-context\fP=""

diff --git a/docs/man/man1/tkn-hub-install.1 b/docs/man/man1/tkn-hub-install.1
@@ -46,10 +46,9 @@ Install a resource from a catalog by its kind, name and version
 
 .SH OPTIONS INHERITED FROM PARENT COMMANDS
 .PP
-\fB\-\-api\-server\fP=""
-    Hub API Server URL (default '
-\[la]https://api.hub.tekton.dev'\[ra]).
-URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'HUB\_API\_SERVER'.
+\fB\-\-api\-server\fP="
+\[la]https://api.hub.tekton.dev"\[ra]
+    Hub API Server URL
 
 
 .SH SEE ALSO

diff --git a/docs/man/man1/tkn-hub-reinstall-task.1 b/docs/man/man1/tkn-hub-reinstall-task.1
@@ -26,10 +26,9 @@ Reinstall a Task by its name
 
 .SH OPTIONS INHERITED FROM PARENT COMMANDS
 .PP
-\fB\-\-api\-server\fP=""
-    Hub API Server URL (default '
-\[la]https://api.hub.tekton.dev'\[ra]).
-URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'HUB\_API\_SERVER'.
+\fB\-\-api\-server\fP="
+\[la]https://api.hub.tekton.dev"\[ra]
+    Hub API Server URL
 
 .PP
 \fB\-c\fP, \fB\-\-context\fP=""