Skip to content

Conversation

@madolson
Copy link
Contributor

@madolson madolson commented Mar 8, 2022

The command json documents should just include information about the "arguments" and the "outputs". I removed all of the 'functional wording' so it's clear. Maybe we should document the history field somewhere too?

to do:

  • add all of this information manually to the docs once we have consensus here

Copy link
Member

@oranagra oranagra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm guessing that all of these where added in the json files simply by copying them from the history sections of redis-doc (deleting them from one place and adding them in another).
so now when we delete them from here, please make a redis-doc PR to add these details these so we don't end up losing them.

also, let's be sure to get @itamarhaber's feedback before merging, just to be sure we're not overlooking something.

@itamarhaber
Copy link
Member

The texts definitely need some TLC - go at it @madolson !!

@madolson
Copy link
Contributor Author

Yes, I am looking at this again. Such a long poll cycle :octocat:

@oranagra
Copy link
Member

@madolson what's the status here? can we merge it or waiting for anything else?

@madolson
Copy link
Contributor Author

madolson commented Apr 5, 2022

@itamarhaber A question for you, I have no idea what is going on in the redis-doc pages these days. What is the best way to add the documentation that was removed here back into the redis-doc pages.

@madolson
Copy link
Contributor Author

madolson commented Apr 5, 2022

@oranagra The blocker is that we want to transfer the docs, but I'm not entirely clear what is going on with the docs atm. We can merge it and I can create an issue there to just unblock the release.

@oranagra
Copy link
Member

oranagra commented Apr 5, 2022

@madolson not sure what you mean.. just make a PR to redis-doc repo to re-add that information.
it'll obviously not fit in the automatically generated history section, since that's done from the json file, but it can be some additional history paragraph right above it.

@oranagra oranagra merged commit 4ffcec2 into redis:unstable Apr 5, 2022
oranagra pushed a commit to redis/redis-doc that referenced this pull request Apr 5, 2022
Added a section for behavior change history as a replacement for redis/redis#10398.
enjoy-binbin pushed a commit to enjoy-binbin/redis that referenced this pull request Jul 31, 2023
…tion (redis#10398)

The command json documents should just include information about the "arguments" and the "outputs".
I removed all of the 'functional wording' so it's clear.
guybe7 added a commit to guybe7/redis-doc that referenced this pull request Feb 19, 2024
oranagra pushed a commit to redis/redis-doc that referenced this pull request Feb 19, 2024
sundb added a commit that referenced this pull request Feb 24, 2025
As discussed in
#13749 (comment).
After #10398 we should record only the arguments and output changes in
the command history, while placing all others in the redis-doc, so
revert #13749.
funny-dog pushed a commit to funny-dog/redis that referenced this pull request Sep 17, 2025
…#13827)

As discussed in
redis#13749 (comment).
After redis#10398 we should record only the arguments and output changes in
the command history, while placing all others in the redis-doc, so
revert redis#13749.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants