Skip to content

Fixed instructions in Redis container docs #1486

New issue

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

By clicking “No 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? No Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sbkok
Copy link

@sbkok sbkok commented May 28, 2019

Updated docs as the current instructions are not working.

Added instructions to:

  • Connect to a redis server running in docker from the local machine.
  • Connect with redis-cli to a redis server when both run in docker using docker networks.


```console
$ docker run --name some-redis -p 127.0.0.1:6379:6379 -d %%IMAGE%%
```
Copy link
Member

Choose a reason for hiding this comment

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

I'd rather not suggest this to users, since this is really something that should be easily inferred by someone familiar with Docker and/or how -p works (and we'd prefer to keep the documentation somewhat succinct and specific to Redis instead of a general guide to using Docker).

```console
$ docker run -it --network some-network --rm %%IMAGE%% redis-cli -h some-redis
$ docker network create some-network
```
Copy link
Member

Choose a reason for hiding this comment

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

Along similar lines, the docker network create bits were intentionally left out of #1441 (as implied by the title) -- we'd prefer not to document Docker basics here and instead provide more reference/tips for using Redis with this image.

@sbkok
Copy link
Author

sbkok commented Jun 7, 2019

Thanks for the review @tianon. I agree that we should not completely duplicate the instructions as provided by the docker docs, however, at the moment the instructions in the doc make it look like it should have worked if you first run the server followed by running the redis cli.

In my opinion, we should at least point the user in the right direction by referencing the docs on how to set it up if you don’t want to include step-by-step instructions. What do you think about this?

No Sign up for free to join this conversation on GitHub. Already have an account? No Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants