Rewrite Redis => Redict #3

ddevault commented 2024年03月23日 11:27:12 +01:00

No description provided.

moonglum commented 2024年03月26日 12:07:31 +01:00

Let me try to clarify the task here, before I work on it:

• clients, libraries and tools: I don't think we should rewrite anything in that directory right now: The clients listed there are targetting Redis, so I think it would be a bit weird to change "A full featured Redis client for Pharo" to "A full featured Redict client for Pharo". Right? 🤔
• modules and modules.json: I think the same is true for them, right?
• commands and docs: Here the task is pretty clear to me 👍
• community: Here, the bigger question is: Do we have replacements for all the things listed there? It mentions the Discord Server, Mailing List, Twitter Account. I think our community setup is described. Maybe we can just remove this directory altogether, as that page supersedes it?
• wordlist: Not sure what that is?

Let me try to clarify the task here, before I work on it: * `clients`, `libraries` and `tools`: I don't think we should rewrite anything in that directory right now: The clients listed there are targetting Redis, so I think it would be a bit weird to change "A full featured Redis client for Pharo" to "A full featured Redict client for Pharo". Right? 🤔 * `modules` and `modules.json`: I think the same is true for them, right? * `commands` and `docs`: Here the task is pretty clear to me 👍 * `community`: Here, the bigger question is: Do we have replacements for all the things listed there? It mentions the Discord Server, Mailing List, Twitter Account. I think [our community setup is described](https://redict.io/docs/community/). Maybe we can just remove this directory altogether, as that page supersedes it? * `wordlist`: Not sure what that is?

ddevault commented 2024年03月26日 12:09:28 +01:00

I don't think we should rewrite anything in that directory right now: The clients listed there are targetting Redis, so I think it would be a bit weird to change "A full featured Redis client for Pharo" to "A full featured Redict client for Pharo". Right? 🤔

Agreed.

community

we can probably remove that

wordlist

I think they have a spellcheck linter for the CI, we can remove that imo

> I don't think we should rewrite anything in that directory right now: The clients listed there are targetting Redis, so I think it would be a bit weird to change "A full featured Redis client for Pharo" to "A full featured Redict client for Pharo". Right? 🤔 Agreed. > community we can probably remove that > wordlist I think they have a spellcheck linter for the CI, we can remove that imo

moonglum commented 2024年03月28日 17:03:09 +01:00

Okay, so that means this task consists of:

• Rewrite Redis to Redict in commands
• Rewrite Redis to Redict in docs/data-types
• Rewrite Redis to Redict in docs/get-started
• Rewrite Redis to Redict in docs/interact
• Rewrite Redis to Redict in docs/management
• Rewrite Redis to Redict in docs/manual
• Rewrite Redis to Redict in docs/reference

Okay, so that means this task consists of: - [x] Rewrite Redis to Redict in `commands` - [x] Rewrite Redis to Redict in `docs/data-types` - [x] Rewrite Redis to Redict in `docs/get-started` - [x] Rewrite Redis to Redict in `docs/interact` - [ ] Rewrite Redis to Redict in `docs/management` - [ ] Rewrite Redis to Redict in `docs/manual` - [ ] Rewrite Redis to Redict in `docs/reference`

moonglum commented 2024年03月28日 23:39:40 +01:00

A few questions:

• docs/about: I would tend to remove this. It contains infos on license (which does not apply), releases (not sure if it applies) and users (do not apply).
• docs/connect: Infos on connecting to Redis with Dotnet, Go, Java, Node and Python. Should we keep it?
• docs/install: I think this needs to be adjusted quite a bit. Especially because it also talks about "Redis Stack". There is also a full file to explain how to install Redis Insight, which I would also remove.

A few questions: * `docs/about`: I would tend to remove this. It contains infos on license (which does not apply), releases (not sure if it applies) and users (do not apply). * `docs/connect`: Infos on connecting to Redis with Dotnet, Go, Java, Node and Python. Should we keep it? * `docs/install`: I think this needs to be adjusted quite a bit. Especially because it also talks about "Redis Stack". There is also a full file to explain how to install Redis Insight, which I would also remove.

ddevault commented 2024年03月29日 11:13:42 +01:00

docs/about: I would tend to remove this. It contains infos on license (which does not apply), releases (not sure if it applies) and users (do not apply).

+1

docs/connect: Infos on connecting to Redis with Dotnet, Go, Java, Node and Python. Should we keep it?

Meh? I think if we get a client list working based on #11, then it's not important to document them in prose; we can just defer to the client documentation.

docs/install: I think this needs to be adjusted quite a bit. Especially because it also talks about "Redis Stack". There is also a full file to explain how to install Redis Insight, which I would also remove.

Yeah, I think we need to rewrite this (I plan on doing that today).

>docs/about: I would tend to remove this. It contains infos on license (which does not apply), releases (not sure if it applies) and users (do not apply). +1 >docs/connect: Infos on connecting to Redis with Dotnet, Go, Java, Node and Python. Should we keep it? Meh? I think if we get a client list working based on #11, then it's not important to document them in prose; we can just defer to the client documentation. >docs/install: I think this needs to be adjusted quite a bit. Especially because it also talks about "Redis Stack". There is also a full file to explain how to install Redis Insight, which I would also remove. Yeah, I think we need to rewrite this (I plan on doing that today).

moonglum commented 2024年03月29日 11:21:32 +01:00

Great! Removed docs/about and docs/connect in my PR. I'll leave docs/install to you 👍

Great! Removed docs/about and docs/connect in my PR. I'll leave docs/install to you 👍

moonglum commented 2024年03月31日 18:58:21 +02:00

Next step is to integrate these into redict.io? I think these files can be moved rather than trying to rig them up to the data system like we do for command docs.

I agree, yes 👍 docs/management, docs/manual and docs/reference are not yet re-written. But we can migrate over the other pages already imho!

If that works for you, I would copy over the files from docs/data-types to the redict.io repo content/docs/data-types (I would flatten probabilistic/hyperloglogs.md to hyperloglogs.md while doing that). Give me a quick thumbs up, and I'll move it over.

You already moved docs/interact/programmability to https://redict.io/docs/scripting, right? pubsub and transactions need to move over as well, right?

> Next step is to integrate these into redict.io? I think these files can be moved rather than trying to rig them up to the data system like we do for command docs. I agree, yes 👍 `docs/management`, `docs/manual` and `docs/reference` are not yet re-written. But we can migrate over the other pages already imho! If that works for you, I would copy over the files from `docs/data-types` to the redict.io repo `content/docs/data-types` (I would flatten `probabilistic/hyperloglogs.md` to `hyperloglogs.md` while doing that). Give me a quick thumbs up, and I'll move it over. You already moved docs/interact/programmability to https://redict.io/docs/scripting, right? pubsub and transactions need to move over as well, right?

ddevault commented 2024年03月31日 18:59:37 +02:00

You already moved docs/interact/programmability to https://redict.io/docs/scripting, right? pubsub and transactions need to move over as well, right?

Yep. I didn't think that pubsub and transactions were well placed in the same section as the Lua docs, though, I think they should have a different home in the end.

>You already moved docs/interact/programmability to https://redict.io/docs/scripting, right? pubsub and transactions need to move over as well, right? Yep. I didn't think that pubsub and transactions were well placed in the same section as the Lua docs, though, I think they should have a different home in the end.

moonglum commented 2024年04月01日 12:28:05 +02:00

Yep. I didn't think that pubsub and transactions were well placed in the same section as the Lua docs, though, I think they should have a different home in the end.

What do you think about putting them into the new "Usage" section?

> Yep. I didn't think that pubsub and transactions were well placed in the same section as the Lua docs, though, I think they should have a different home in the end. What do you think about putting them into the new "Usage" section?

ddevault commented 2024年04月01日 12:34:32 +02:00

I think that's the perfect home for them.

I think that's the perfect home for them.

moonglum commented 2024年04月01日 12:44:40 +02:00

Great! Then my next PR will be the usage section.

Great! Then my next PR will be the usage section.