Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation review for publishing #91

Open
23 of 70 tasks
madolson opened this issue May 20, 2024 · 73 comments
Open
23 of 70 tasks

Documentation review for publishing #91

madolson opened this issue May 20, 2024 · 73 comments

Comments

@madolson
Copy link
Member

madolson commented May 20, 2024

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.
  • :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
@madolson madolson changed the title Documentation review for website Documentation review for publishing May 20, 2024
@stockholmux
Copy link
Member

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)

@stockholmux
Copy link
Member

See #96 for my review of admin.md

@stockholmux
Copy link
Member

bitfields.md reviewed ✅

@stockholmux
Copy link
Member

bitmaps.md reviewed. Looks good except for my uncertainty around #97

@stockholmux
Copy link
Member

cli.md reviewed ✅

@stockholmux
Copy link
Member

clients.md reviewed ✅

@stockholmux
Copy link
Member

command-tips.md reviewed, non-blocking minor issues (see #99 )

@stockholmux
Copy link
Member

data-types.md reviewed, non-blocking minor issues on the website side (valkey-io/valkey-io.github.io#75) and content (#100)

@stockholmux
Copy link
Member

debugging.md reviewed ✅

@stockholmux
Copy link
Member

distlock.md reviewed, needs work (#101)

@stockholmux
Copy link
Member

encryption.md reviewed ✅

@stockholmux
Copy link
Member

eval-intro.md reviewed, needs work (#102)

@stockholmux
Copy link
Member

faq.md reviewed, needs work (#103)

@stockholmux
Copy link
Member

functions-intro.md reviewed, needs minor work (#104)

@stockholmux
Copy link
Member

geospatial.md reviewed ✅

@stockholmux
Copy link
Member

get-started.md reviewed ✅ but isn't very useful at the moment. I added #105 to track expanding it.

@stockholmux
Copy link
Member

hashes.md reviewed, needs minor work to fix (#106)

@stockholmux
Copy link
Member

history.md reviewed ✅

@stockholmux
Copy link
Member

hyperloglogs.md reviewed ✅

@stockholmux
Copy link
Member

indexing.md reviewed ✅ (small issue with syntax highlighting #107)

@stockholmux
Copy link
Member

stockholmux commented May 31, 2024

security.md reviewed, needs work (#131)

@stockholmux
Copy link
Member

stockholmux commented May 31, 2024

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

@stockholmux
Copy link
Member

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

@stockholmux
Copy link
Member

sets.md reviewed ✅

@stockholmux
Copy link
Member

stockholmux commented May 31, 2024

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

@stockholmux
Copy link
Member

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

@stockholmux
Copy link
Member

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

@stockholmux
Copy link
Member

strings.md reviewed ✅

@stockholmux
Copy link
Member

stockholmux commented May 31, 2024

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

@stockholmux
Copy link
Member

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

@stockholmux
Copy link
Member

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

@stockholmux
Copy link
Member

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

@stockholmux
Copy link
Member

client-side-caching.md reviewed ✅

@stockholmux
Copy link
Member

stockholmux commented May 31, 2024

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

@stockholmux
Copy link
Member

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

@stockholmux
Copy link
Member

command-arguments.md reviewed ✅

@stockholmux
Copy link
Member

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
Copy link
Member

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

@stockholmux
Copy link
Member

@madolson I've reviewed all the documentation.

zuiderkwast added a commit that referenced this issue Jul 3, 2024
Fix multiple issues found during the full doc review #91.

Fixes #120, fixes #121, fixes #122, fixes #124, fixes #125, fixes #126,
fixes #127, fixes #128, fixes #130, fixes #131, fixes #132, fixes #133,
fixes #134, fixes #135, fixes #136, fixes #137, fixes #138, fixes #139,
fixes #140, fixes #141.

---------

Signed-off-by: Viktor Söderqvist <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants