Documentation review for publishing
madolson opened this issue · 73 comments
We want to have someone review each topic to validate it still makes sense and are self-coherent. Specifically review the following usage:
- Make sure all usage of Redis is either correctly using Redis OSS, and remove all references to Redis proprietary features (Redis enterprise, Redis cloud, Redis stack)
- Remove all references to old and unsupported versions of Redis OSS (pre 6.0).
- Make sure that master and slave are replaced with primary replica.
- :acl.md @madolson
- :admin.md
- :benchmark.md
- :bitfields.md
- :bitmaps.md
- :cli.md
- :client-side-caching.md
- :clients.md
- :cluster-spec.md
- :cluster-tutorial.md
- :command-arguments.md
- :command-tips.md
- :data-types.md
- :debugging.md
- :distlock.md
- :encryption.md
- :eval-intro.md
- :faq.md
- :functions-intro.md
- :geospatial.md
- :get-started.md
- :hashes.md
- :history.md
- :hyperloglogs.md
- :index.md
- :indexing.md
- :installation.md
- :internals-eventlib.md
- :internals-sds.md
- :internals-vm.md
- :internals.md
- :introduction.md
- :key-specs.md
- :keyspace.md
- :latency-monitor.md
- :latency.md
- :ldb.md
- :license.md
- :lists.md
- :lru-cache.md
- :lua-api.md
- :mass-insertion.md
- :memory-optimization.md
- :modules-api-ref.md
- :modules-blocking-ops.md
- :modules-intro.md
- :modules-native-types.md
- :notifications.md
- :performance-on-cpu.md
- :persistence.md
- :pipelining.md
- :problems.md
- :programmability.md
- :protocol.md
- :pubsub.md
- :quickstart.md
- :rdd.md
- :releases.md
- :replication.md
- :security.md
- :sentinel-clients.md
- :sentinel.md
- :sets.md
- :signals.md
- :sorted-sets.md
- :streams-intro.md
- :strings.md
- :transactions.md
- :twitter-clone.md
- :valkey.conf.md
A few other things that are vital to this review:
- Obvious history revisions (e.g. Salvatore created Valkey)
- Left over promises or future directional (e.g. 'We'd like valkey to run on android')
- Check to make sure that it works in the website
(I'm curious if we should manage this issue from the website repo because we can flagging it with the config.extra.review_list)
See #96 for my review of admin.md
bitfields.md reviewed ✅
bitmaps.md reviewed. Looks good except for my uncertainty around #97
cli.md reviewed ✅
clients.md reviewed ✅
command-tips.md reviewed, non-blocking minor issues (see #99 )
data-types.md reviewed, non-blocking minor issues on the website side (valkey-io/valkey-io.github.io#75) and content (#100)
debugging.md reviewed ✅
distlock.md reviewed, needs work (#101)
encryption.md reviewed ✅
eval-intro.md reviewed, needs work (#102)
faq.md reviewed, needs work (#103)
functions-intro.md reviewed, needs minor work (#104)
geospatial.md reviewed ✅
get-started.md reviewed ✅ but isn't very useful at the moment. I added #105 to track expanding it.
hashes.md reviewed, needs minor work to fix (#106)
history.md reviewed ✅
hyperloglogs.md reviewed ✅
indexing.md reviewed ✅ (small issue with syntax highlighting #107)
installation.md reviewed ✅ but could probably use a modern refresh (see #108)
internals-eventlib.md reviewed. ❌ we should yank this documentation from Valkey (see #109)
internals-sds.md reviewed ✅ . (Like internals-eventlib.md it's historical but lacks many of the confusing issue and I think how SDS works is still relevant in 2024)
internals-vm.md reviewed ❌ we should also remove this documentation from Valkey (see #110 for details)
internals.md reviewed ❌ . Looks like this isn't really a docs page just a disclaimer - regardless, probably not useful to include in valkey.io
introduction.md reviewed ✅ needs some minor work though #111
key-specs.md reviewed ✅
keyspace.md reviewed ✅
latency-monitor.md reviewed ✅ except for a minor issue about single-threadedness (#112)
latency.md reviewed. Has a couple of things that need to be removed, but mostly just badly out of date (#113)
ldb.md reviewed ✅ (No content issue but the embedded video breaks the layout on mobile valkey-io/valkey-io.github.io#76)
lists.md reviewed ✅
lru-cache.md reviewed ✅ has old but info that needs to be refactored.
lua-api.md reviewed but has many issues #116
mass-insertion.md reviewed ✅ only small-ish issues (#117)
memory-optimization.md reviewed ✅ - some confusing titles, but nothing huge.
@zuiderkwast I recall you saying that modules-api-ref.md is generated so no use in reviewing it here.
modules-blocking-ops.md reviewed, needs some work (#120)
modules-intro.md needs work. Either this documentation was never finished or it represents a slice in time (and probably should be deleted) (#121)
Isn't master => primary is a huge change? The docs are consistently using master-replica. I think we should do it, but I maybe not in the same issue/PR?
@zuiderkwast I recall you saying that
modules-api-ref.mdis generated so no use in reviewing it here.
It's generated from code comments in the code repo. We can still change the text, but it has to be done in the code, then generate the markdown file from that.
modules-native-types.md reviewed ✅ , needs a little work (#122) but nothing show stopping.
notifications.md reviewed ✅
performance-on-cpu.md reviewed ✅ , very minor non-blocking issue (#124)
persistence.md reviewed ✅
pipelining.md reviewed ✅ , minor non-blocking issues (#125)
problems.md reviewed ✅
programmability.md reviewed ✅ , has a few issues (#126)
protocol.md reviewed. Needs quite a bit of work (#127)
pubsub.md reviewed. Needs a little work to remove ancient broken example (#128)
quickstart.md reviewed ✅
/topics/rdd.md reviewed, needs a little work to clarify naming ( #129)
releases.md reviewed ✅
replication.md reviewed, needs a little work.
security.md reviewed, needs work (#131)
sentinel-clients.md reviewed, needs work (#132)
sentinel.md reviewed, has many problems (#133)
sets.md reviewed ✅
signals.md reviewed ✅ , needs minor work (#134)
sorted-sets.md reviewed ✅ , one small issue (#135)
streams-intro.md reviewed ✅ , one small issue (#136)
strings.md reviewed ✅
transactions.md reviewed, needs a small change (#137)
twitter-clone.md reviewed ✅ , two small non-critical issues.
valkey.conf.md reviewed ✅ (I'm not crazy about the double extension in the file name, I think it will cause problems eventually)
benchmark.md reviewed ✅ , has some very outdated info that should be updated, but not critical
client-side-caching.md reviewed ✅
cluster-spec.md reviewed, needs some work (#140)
cluster-tutorial.md reviewed, has a problematic code block.
command-arguments.md reviewed ✅
modules-api-ref.md lightly reviewed ✅
This one is maybe a little out-of-scope since it's generated from source code, but I can confirm that it works as a webpage.
license.md needs work. Asked for more in depth review.
@madolson I've reviewed all the documentation.