From 09519bb03f474fb0abd6e866902d8122fe0dbd79 Mon Sep 17 00:00:00 2001 From: James Rasell Date: Mon, 13 Jan 2020 15:45:14 +0100 Subject: [PATCH] system CLI documentation fixes based on feedback from @angrycub --- website/source/docs/commands/system.html.md | 3 ++- website/source/docs/commands/system/gc.html.md.erb | 1 + website/source/layouts/docs.erb | 4 ++-- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/website/source/docs/commands/system.html.md b/website/source/docs/commands/system.html.md index ab46f7ec6..89611e1d6 100644 --- a/website/source/docs/commands/system.html.md +++ b/website/source/docs/commands/system.html.md @@ -8,7 +8,8 @@ description: > # Command: system -The `system` command is used to interact with namespaces. +The `system` command is used to interact with the system API. These calls are +used for system maintenance and should not be necessary for most users. ## Usage diff --git a/website/source/docs/commands/system/gc.html.md.erb b/website/source/docs/commands/system/gc.html.md.erb index 09dd48452..1db16e6f9 100644 --- a/website/source/docs/commands/system/gc.html.md.erb +++ b/website/source/docs/commands/system/gc.html.md.erb @@ -9,6 +9,7 @@ description: > # Command: system gc Initializes a garbage collection of jobs, evaluations, allocations, and nodes. +This is an asynchronous operation. ## Usage diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index b19868d72..b8e883c1b 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -355,10 +355,10 @@ system