redict/redict-doc
redict/redict-doc
7
3
Fork 3
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity

Rewrite Redis => Redict #3

New issue
Open
opened 2024-03-23 11:27:12 +01:00 by ddevault · 11 comments
ddevault commented 2024-03-23 11:27:12 +01:00
Owner
Copy link
No description provided.
moonglum commented 2024-03-26 12:07:31 +01:00
Owner
Copy link

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
Author
Owner
Copy link

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
ddevault referenced this issue from a commit 2024-03-28 16:53:25 +01:00
Remove unneeded files #3
moonglum commented 2024-03-28 17:03:09 +01:00
Owner
Copy link

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

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
Author
Owner
Copy link

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

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 👍
👍 1
moonglum commented 2024-03-31 18:58:21 +02:00
Owner
Copy link

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?
👍 1
ddevault commented 2024-03-31 18:59:37 +02:00
Author
Owner
Copy link

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

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
Author
Owner
Copy link

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

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

Great! Then my next PR will be the usage section.
👍 1
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels   
bug
Something is not working

  
contribution welcome
Contributions are very welcome, get started here

  
duplicate
This issue or pull request already exists

  
enhancement
New feature

  
good first issue
Interested in contributing? Get started here.

  
help wanted
Need some help

  
invalid
Something is wrong

  
question
More information is needed

  
upstream
Related to an upstream repository, already reported there

No labels
bug
contribution welcome
duplicate
enhancement
good first issue
help wanted
invalid
question
upstream
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
redict/redict-doc#3
No description provided.