Closed stockholmux closed 3 months ago
I'm removing the reference to Redis OSS 3 and reverting to "adapted to Redis coding style".
All code blocks should move to backticks/syntax highlighter for readability.
There's no usable language to use for syntax highlighting of Valkey commands like CLUSTER MEET ip port
. If there would be a language we could mark it as, I'd buy the change to backticks, but without it, I'm going to ignore this comment. We're not changing just for the sake of changing.
It's not a change for the sake of changing.
CLUSTER MEET ip port
doesn't render properly as a code block in either GitHub nor on the website.
Do you mean it's indented less than 4 spaces? Because there's no difference between
CLUSTER MEET ip port
and
CLUSTER MEET ip port
It's under a bullet list item so it'd need to be indented more. Or switch to backticks to avoid the problem of nested indentation.
The crap about syntax highlighing is what made me disregard the entire comment as trolling.
I am (generally) not trolling. I actually think it should be fixed as in #149.
The use of the code block here is super inconsistent with the rest of the document.
Hehe, I know! 😄 But syntax highlighting for valkey commands and other pseudo code is still hard to take serious, unless you have a specific language it can be tagged as. 😉
On the subject of fenced code blocks and languages...
Of the 383ms it takes to build the website, I'm fairly sure most of that time is emitting this warning about valkey-cli
to stdout hundreds of times.
I don't care that much because the whole website builds faster than a browser takes to rendering a single page, but ideally we should get rid valkey-cli
on code blocks (unless you know something I don't!)
Yes I can tell you what I know. Thanks for bringing it up.
Previously this was some hugo code which isn't valid markdown, so it broke rendering (or rendered as visible braces, etc ) when fed to markdown tools. I mass-replaced them to keep this as a place-holder in case we ever want to use it for interactive examples or maybe add a custom syntax highlighter for these valkey-cli sessions. (I assume that could be done, at least in theory.)
This valkey-cli tag is just an unknown language, but it's still valid markdown and is ignored by any markdown tool and doesn't affect the rendering of the page (though a warning is printed in this cas), so it's unintrusive in that sense.
I'm fine with deleting it if you don't think we'll have any use for it.
In pre-publishing review (#91), I found the following issues:
Drop this reference to an ancient version.
Use of code backticks for inline code.
This should probably revert back to 'redis' since Salvatore didn't adapt it to Valkey.
All code blocks should move to backticks/syntax highlighter for readability.
Finally, looks like there are 196 references that need to be updated to 'primary'.