need to point to directions in docs and remove example docker-compose.yml file in this repo

Open
#156 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
docker, docker-compose

Research direction

Start by comparing the repository's docker-compose.yml with the working example at https://go.rocket.chat/i/docker-compose.yml and read the installation guidance at the linked Rocket.Chat documentation. Check README.md for the setup instructions; done means the outdated example is removed and the README points users to the current Docker Compose documentation.

Written by the indexing model from the issue text.

Description

I couldn't get rocket chat to work with the docker-compose.yml file in this repo. I finally looked at the docs from the main repo and followed them. Those link to a completely different docker-compose.yml example file that works.

To avoid user failure I'd remove the one in this repo and link to the docs in the readme.md.

https://go.rocket.chat/i/docker-compose.yml

https://docs.rocket.chat/quick-start/installing-and-updating/docker-containers/docker-compose

Dominant language
Dockerfile
Stars
336
Forks
226
Avg merge
21d 4h
Merged PRs (30d)
1

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from RocketChat/Docker.Official.Image

All issues in RocketChat/Docker.Official.Image

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.