Add command hyperlinks for server management command files #332
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added hyperlink for ACL HELP command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for ACL SETUSER command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for the ACL SAVE command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlinks for the AUTH and HELLO commands. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlinks for SET, GET, KEYS, AUTH, ACL CAT, CLIENT KILL, and ACL DELUSER commands. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for AUTH command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for INFO command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for LASTSAVE command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlinks to GET, MGET, LATENCY, COMMAND GETKEYS, SWAPDB, SYNC, MONITOR, SLOWLOG, SORT, ZUNION, MIGRATE, BRPOPLPUSH, SMOVE, RENAME, MSET, and CONFIG REWRITE commands. Did some minor editing in order to add hyperlinks. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for COMMAND GETKEYSANDFLAGS command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for COMMAND and COMMAND GETKEYS commands. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for the COMMAND command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for COMMANDLOG HELP command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlinks to COMMANDLOG RESET and CLIENT SETNAME commands. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for the COMMANDLOG RESET command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for CONFIG HELP command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for CONFIG SET command and the valkey-cli (topics/cli.md) Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlinks to the INFO and LATENCY HISTOGRAM commands. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for CONFIG SET command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for CONFIG GET command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink to CLUSTER FAILOVER, CLIENT PAUSE WRITE , INFO, and REPLICAOF commands where referenced. Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Added tick marks to all command hyperlinks Added hyperlink for ACL CAT command Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
…perlink for PSYNC FAILOVER Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
… command Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
…ting Reformatted modifier names with tick marks instead of bolded text. Added hyperlinks for commands. Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
PingXie
approved these changes
Jul 10, 2025
zuiderkwast
reviewed
Jul 13, 2025
There was a problem hiding this comment.
Great @milliehartnt123, thank you!
@stockholmux we have been talking about making these links automatic. I think explicit links is pretty good. In this way we can be sure we don't link wrong for some words that look like commands but are not. WDYT?
| @@ -6,4 +6,4 @@ The maximum number of entries in the different command log is governed by the `c | |||
|
|
|||
| Once the command log reaches its maximal size, the oldest entry is removed whenever a new entry is created. | |||
|
|
|||
| The command log can be cleared with the `COMMANDLOG RESET` command. | |||
| The command log can be cleared with the [`COMMANDLOG RESET`](connandlog-reset.md) command. | |||
zuiderkwast
changed the title
|
@zuiderkwast yeah, I would be for linking explicitly instead of some script or regex that might be confusingly wrong. Is this something we'd manually check for on PR review? E.g. someone submits docs is that going to be noted as feedback? |
Yeah, I suppose we will ask contributors to add links to commands when missing. It will be more natural when it is seen everywhere in existing docs. Should we have some automatic checker? IMO we don't need to link all occurrences, but the first occurrence on each page would be good to link, at least. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The following files were modified. Some of the files have two sets of commits, with one set being to add the tick marks back to the hyperlink for formatting.