From 5a17971b1cc97c8e2141deb9f77532a047d97ce8 Mon Sep 17 00:00:00 2001 From: Steven Pitts <25968054+makusu2@users.noreply.github.com> Date: Sat, 19 Dec 2020 14:20:46 -0500 Subject: [PATCH] kubectl: add kubectl describe in header (#5032) https://github.com/tldr-pages/tldr/pull/4494 added `kubectl describe` help, but the main page still doesn't mention it. Add a note about its usage. This is an important command, but it exceeds the suggested limit of 8 examples (do subcommands count as "examples"?). We could instead replace the `kubectl get` example with `kubectl {{get|describe}}`, but I'm really not a fan of that, since they're two different subcommands. --- pages/common/kubectl.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pages/common/kubectl.md b/pages/common/kubectl.md index d2a4f5a6ab..2f5aa68462 100644 --- a/pages/common/kubectl.md +++ b/pages/common/kubectl.md @@ -1,9 +1,10 @@ # kubectl > Command line interface for running commands against Kubernetes clusters. +> See also `kubectl describe` and other pages for additional information. > More information: . -- List all information about a resource with more details: +- List information about a resource with more details: `kubectl get {{pod|service|deployment|ingress|...}} -o wide`