valkey-io / valkey-doc

Other
18 stars 25 forks source link

Documentation review for publishing #91

Open madolson opened 1 month ago

madolson commented 1 month ago

We want to have someone review each topic to validate it still makes sense and are self-coherent. Specifically review the following usage:

  1. 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)
  2. Remove all references to old and unsupported versions of Redis OSS (pre 6.0).
  3. Make sure that master and slave are replaced with primary replica.

    • [X] :acl.md @madolson
    • [ ] :admin.md
    • [ ] :benchmark.md
    • [x] :bitfields.md
    • [ ] :bitmaps.md
    • [x] :cli.md
    • [ ] :client-side-caching.md
    • [x] :clients.md
    • [ ] :cluster-spec.md
    • [ ] :cluster-tutorial.md
    • [ ] :command-arguments.md
    • [ ] :command-tips.md
    • [ ] :data-types.md
    • [x] :debugging.md
    • [ ] :distlock.md
    • [x] :encryption.md
    • [ ] :eval-intro.md
    • [ ] :faq.md
    • [ ] :functions-intro.md
    • [x] :geospatial.md
    • [ ] :get-started.md
    • [ ] :hashes.md
    • [x] :history.md
    • [x] :hyperloglogs.md
    • [ ] :index.md
    • [x] :indexing.md
    • [x] :installation.md
    • [ ] :internals-eventlib.md
    • [x] :internals-sds.md
    • [ ] :internals-vm.md
    • [ ] :internals.md
    • [x] :introduction.md
    • [x] :key-specs.md
    • [x] :keyspace.md
    • [x] :latency-monitor.md
    • [ ] :latency.md
    • [x] :ldb.md
    • [ ] :license.md
    • [x] :lists.md
    • [x] :lru-cache.md
    • [ ] :lua-api.md
    • [x] :mass-insertion.md
    • [x] :memory-optimization.md
    • [ ] :modules-api-ref.md
    • [ ] :modules-blocking-ops.md
    • [ ] :modules-intro.md
    • [x] :modules-native-types.md
    • [x] :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
stockholmux commented 1 month ago

quickstart.md reviewed ✅

stockholmux commented 1 month ago

/topics/rdd.md reviewed, needs a little work to clarify naming ( #129)

stockholmux commented 1 month ago

releases.md reviewed ✅

stockholmux commented 1 month ago

replication.md reviewed, needs a little work.

stockholmux commented 1 month ago

security.md reviewed, needs work (#131)

stockholmux commented 1 month ago

sentinel-clients.md reviewed, needs work (#132)

stockholmux commented 1 month ago

sentinel.md reviewed, has many problems (#133)

stockholmux commented 1 month ago

sets.md reviewed ✅

stockholmux commented 1 month ago

signals.md reviewed ✅ , needs minor work (#134)

stockholmux commented 1 month ago

sorted-sets.md reviewed ✅ , one small issue (#135)

stockholmux commented 1 month ago

streams-intro.md reviewed ✅ , one small issue (#136)

stockholmux commented 1 month ago

strings.md reviewed ✅

stockholmux commented 1 month ago

transactions.md reviewed, needs a small change (#137)

stockholmux commented 1 month ago

twitter-clone.md reviewed ✅ , two small non-critical issues.

stockholmux commented 1 month ago

valkey.conf.md reviewed ✅ (I'm not crazy about the double extension in the file name, I think it will cause problems eventually)

stockholmux commented 1 month ago

benchmark.md reviewed ✅ , has some very outdated info that should be updated, but not critical

stockholmux commented 1 month ago

client-side-caching.md reviewed ✅

stockholmux commented 1 month ago

cluster-spec.md reviewed, needs some work (#140)

stockholmux commented 1 month ago

cluster-tutorial.md reviewed, has a problematic code block.

stockholmux commented 1 month ago

command-arguments.md reviewed ✅

stockholmux commented 1 month ago

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.

stockholmux commented 1 month ago

license.md needs work. Asked for more in depth review.

stockholmux commented 1 month ago

@madolson I've reviewed all the documentation.