content review

Docs markdown would not build in website. 4 pages had malformed markup

  • admin.md
  • cli.md
  • eval-intro.md
  • programmability.md

Ten randomly selected files I reviewed:

/docs/topics/cli/

  • hard links to .md file won't work on website (renders as a webpage)
  • Commands link path is wrong

Rendering:

  • "Continuous stats mode" section breaks rendering totally
  • "Scanning for big keys" breaks rendering

Content:

  • Questionable rebranding REDISCLI_AUTH, REDISCLI_HISTFILE, REDISCLI_RCFILE

/docs/topics/pubsub/

  • relative linking issue ("streams") in 2nd para
  • hard links to .md file

/docs/topics/pipelining/

  • images are linked wrong.
  • hard links to .md file
  • Commands link path is wrong

content:

  • Questionable rebrand "the Valkey Ruby client"

/docs/topics/replication/

  • hard links to .md file
  • relative linking issue

Broken rendering A / B C?

content:

  • Redis OSS 4.0 - still relevant?
  • "Before version 4.0" - still relevant?

/docs/topics/strings/

  • hard links to .md file
  • Incorrect links to commands (and relative problem)
  • Broken rendering

/docs/topics/keyspace/

  • hard links to .md file

/docs/topics/hyperloglogs/

  • incorrect (unsupported?) link to commands (2 different ways)
  • broken rendering
  • Bad re-branding (Antirez never wrote about Valkey)

/docs/topics/internals-vm/

  • bad re-branding (creator of Valkey, Salvatore Sanfilippo)
  • Irrelevant - 15 years old - relevant?
  • References code as Valkey, shows code as Redis

/docs/topics/indexing/

  • hard links to .md file
  • Incorrect link to command
  • Incorrect image path

/docs/topics/arm/

Content problems:

(Is this still true?)

While Valkey does run on Android, in the future we look forward to extend our testing efforts to Android to also make it an officially supported platform.

(Is this ancient history?)

The following numbers were obtained using Redis OSS 4.0.