From 00c85757f7f356dc92ec97f5a3ca6a859337afba Mon Sep 17 00:00:00 2001 From: Ashesh Vidyut <134911583+absolutelightning@users.noreply.github.com> Date: Sat, 17 Jun 2023 07:42:35 +0530 Subject: [PATCH] Fix Docs for Trails Leader By (#17763) * init * fix tests * added -detailed in docs * added change log * fix doc * checking for entry in map * fix tests * removed detailed flag * removed detailed flag * revert unwanted changes * removed unwanted changes * updated change log * pr review comment changes * pr comment changes single API instead of two * fix change log * fix tests * fix tests * fix test operator raft endpoint test * Update .changelog/17582.txt Co-authored-by: Semir Patel * nits * updated docs * explanation added * fix doc * fix docs --------- Co-authored-by: Semir Patel --- website/content/commands/operator/raft.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/content/commands/operator/raft.mdx b/website/content/commands/operator/raft.mdx index 3c2d8a1221af..1b2464cb8b29 100644 --- a/website/content/commands/operator/raft.mdx +++ b/website/content/commands/operator/raft.mdx @@ -68,7 +68,7 @@ configuration. `Commit Index` is the last log index the server has a record of in its Raft log. -`Trails Leader By` is the difference in commit index the server has from the leader. +`Trails Leader By` is the number of commits a follower trails the leader by. #### Command Options @@ -113,7 +113,7 @@ The return code will indicate success or failure. Corresponding HTTP API Endpoint: [\[POST\] /v1/operator/raft/transfer-leader](/consul/api-docs/operator/raft#transfer-raft-leadership) -This command transfers Raft leadership to another server agent. If an `id` is provided, Consul transfers leadership to the server with that id. +This command transfers Raft leadership to another server agent. If an `id` is provided, Consul transfers leadership to the server with that id. Use this command to change leadership without restarting the leader node, which maintains quorum and workload capacity.