Move documentation to redis/redis.io #18

Merged

ddevault merged 2 commits from :main into main

2024-04-02 10:59:23 +02:00

moonglum commented

2024-04-01 18:40:50 +02:00

Owner

This is the companion PR to redict/redict.io#18

It adjusts the links in the commands.

Delete all the documentation that I moved to redict/redict.io. Removed things that are Redis specific (like "Redis Insight") or only in old versions (like Gopher protocol support).

This leaves only a few bits of documentation that did not fit the "Usage" category in my opinion:

docs
├── manual
│  ├── client-side-caching.md
│  └── keyspace-notifications.md
└── reference
   ├── arm.md
   ├── clients.md
   ├── cluster-spec.md
   ├── internals
   │  ├── _index.md
   │  ├── internals-rediseventlib.md
   │  ├── internals-sds.md
   │  ├── internals-vm.md
   │  └── rdd.md
   ├── key-specs.md
   ├── protocol-spec.md
   └── sentinel-clients.md

Most of these are either specs or for implementors. Not sure what we should do with these.

This is the companion PR to https://codeberg.org/redict/redict.io/pulls/18 It adjusts the links in the commands. Delete all the documentation that I moved to `redict/redict.io`. Removed things that are Redis specific (like "Redis Insight") or only in old versions (like Gopher protocol support). This leaves only a few bits of documentation that did not fit the "Usage" category in my opinion: ``` docs ├── manual │ ├── client-side-caching.md │ └── keyspace-notifications.md └── reference ├── arm.md ├── clients.md ├── cluster-spec.md ├── internals │ ├── _index.md │ ├── internals-rediseventlib.md │ ├── internals-sds.md │ ├── internals-vm.md │ └── rdd.md ├── key-specs.md ├── protocol-spec.md └── sentinel-clients.md ``` Most of these are either specs or for implementors. Not sure what we should do with these.

moonglum added 1 commit

2024-04-01 18:40:50 +02:00

Move documentation to redis/redis.io f3df3af77e

moonglum commented

2024-04-01 18:43:19 +02:00

Author

Owner

This does not yet extract the patterns to their own pages as outlined in #15. I will do that as a follow up, but not today 😄

moonglum added 1 commit

2024-04-01 23:10:22 +02:00

Adjust links in commands 8d7a29ab2d

ddevault merged commit 8d7a29ab2d into main

2024-04-02 10:59:23 +02:00

ddevault commented

2024-04-02 11:04:36 +02:00

Owner

What to do with these? Suggestions inline

docs
├── manual
│  ├── client-side-caching.md - usage/clients
│  └── keyspace-notifications.md - usage/clients
└── reference
   ├── arm.md - drop
   ├── clients.md - move to redict/redict codeberg wiki
   ├── cluster-spec.md - move to codeberg wiki
   ├── internals - move to codeberg wiki
   │  ├── _index.md
   │  ├── internals-rediseventlib.md
   │  ├── internals-sds.md
   │  ├── internals-vm.md
   │  └── rdd.md
   ├── key-specs.md - usage/clients
   ├── protocol-spec.md - drop, redundant with RESP3 spec on github (we can discuss adopting the spec later)
   └── sentinel-clients - usage/clients

Summary:

Establish usage/clients for docs whose audience is client authors
Move internal documentation to codeberg wiki
drop everything else

What to do with these? Suggestions inline ``` docs ├── manual │ ├── client-side-caching.md - usage/clients │ └── keyspace-notifications.md - usage/clients └── reference ├── arm.md - drop ├── clients.md - move to redict/redict codeberg wiki ├── cluster-spec.md - move to codeberg wiki ├── internals - move to codeberg wiki │ ├── _index.md │ ├── internals-rediseventlib.md │ ├── internals-sds.md │ ├── internals-vm.md │ └── rdd.md ├── key-specs.md - usage/clients ├── protocol-spec.md - drop, redundant with RESP3 spec on github (we can discuss adopting the spec later) └── sentinel-clients - usage/clients ``` Summary: * Establish usage/clients for docs whose audience is client authors * Move internal documentation to codeberg wiki * drop everything else

moonglum commented

2024-04-02 16:55:14 +02:00

Author

Owner

usage/clients for client authors sounds like a good idea 👍
Let's try out moving these topics to the wiki 👍

Ran a linkchecker yesterday #17, the remaining ones were:

/topics/protocol ⇒ We will link to the RESP3 spec on GitHub instead, right?
/topics/cluster-spec ⇒ Link the wiki
/topics/key-specs ⇒ Link usage/clients/key-specs
/topics/sentinel-clients ⇒ Link usage/clients/sentinel-clients
/topics/notifications ⇒ Link usage/clients/keyspace-notifications

* `usage/clients` for client authors sounds like a good idea 👍 * Let's try out moving these topics to the wiki 👍 Ran a linkchecker yesterday #17, the remaining ones were: * `/topics/protocol` ⇒ We will link to the RESP3 spec on GitHub instead, right? * `/topics/cluster-spec` ⇒ Link the wiki * `/topics/key-specs` ⇒ Link usage/clients/key-specs * `/topics/sentinel-clients` ⇒ Link usage/clients/sentinel-clients * `/topics/notifications` ⇒ Link usage/clients/keyspace-notifications

ddevault commented

2024-04-02 20:49:54 +02:00

Owner