From fbcf4264ff0875b67e8852b7fc2099d0d55a6a13 Mon Sep 17 00:00:00 2001 From: Oscar Utbult Date: Thu, 23 Nov 2023 10:33:21 +0100 Subject: [PATCH] docs: fix talosctl dashboard cli docs Fixes the shortcuts for the dashboard command by encoding < and > Signed-off-by: Oscar Utbult Signed-off-by: Noel Georgi --- cmd/talosctl/cmd/talos/dashboard.go | 16 ++++++++-------- website/content/v1.6/reference/cli.md | 16 ++++++++-------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/cmd/talosctl/cmd/talos/dashboard.go b/cmd/talosctl/cmd/talos/dashboard.go index dd21acfbf..ce21d3e94 100644 --- a/cmd/talosctl/cmd/talos/dashboard.go +++ b/cmd/talosctl/cmd/talos/dashboard.go @@ -26,14 +26,14 @@ var dashboardCmd = &cobra.Command{ Keyboard shortcuts: - - h, : switch one node to the left - - l, : switch one node to the right - - j, : scroll logs/process list down - - k, : scroll logs/process list up - - : scroll logs/process list half page down - - : scroll logs/process list half page up - - : scroll logs/process list one page down - - : scroll logs/process list one page up + - h, <Left> - switch one node to the left + - l, <Right> - switch one node to the right + - j, <Down> - scroll logs/process list down + - k, <Up> - scroll logs/process list up + - <C-d> - scroll logs/process list half page down + - <C-u> - scroll logs/process list half page up + - <C-f> - scroll logs/process list one page down + - <C-b> - scroll logs/process list one page up `, Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/website/content/v1.6/reference/cli.md b/website/content/v1.6/reference/cli.md index 3f38c4674..0ea7fc18a 100644 --- a/website/content/v1.6/reference/cli.md +++ b/website/content/v1.6/reference/cli.md @@ -778,14 +778,14 @@ Provide a text-based UI to navigate node overview, logs and real-time metrics. Keyboard shortcuts: - - h, : switch one node to the left - - l, : switch one node to the right - - j, : scroll logs/process list down - - k, : scroll logs/process list up - - : scroll logs/process list half page down - - : scroll logs/process list half page up - - : scroll logs/process list one page down - - : scroll logs/process list one page up + - h, <Left> - switch one node to the left + - l, <Right> - switch one node to the right + - j, <Down> - scroll logs/process list down + - k, <Up> - scroll logs/process list up + - <C-d> - scroll logs/process list half page down + - <C-u> - scroll logs/process list half page up + - <C-f> - scroll logs/process list one page down + - <C-b> - scroll logs/process list one page up ```