Skip to content
New issue

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

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

(support/docs) Link to docker-compose.yml in doc page points to personal fork #3679

Open
donquixote opened this issue Apr 29, 2024 · 0 comments

Comments

@donquixote
Copy link

Hello,
some feedback about the documentation and the landscape of packages.

https://molgenis.github.io/molgenis-emx2/#/molgenis/run_docker

This doc page contains a link to a docker-compose.yml at https://raw.githubusercontent.com/mswertz/molgenis-emx2/master/docker-compose.yml. This destination file sits in a personal fork of the repo (or maybe this is the original).

The main repo contains a different, more complex version of the file: https://github.com/molgenis/molgenis-emx2/blob/master/docker-compose.yml

Perhaps the simpler file is the correct one to use. It works for me so far.

But, as a developer who wants to run Molgenis with docker-compose, the different files can be confusing:

  • In my local repo I found more or less a copy of the simpler docker-compose config from the personal repo. I added this months ago but did not remember where I found it.
  • When looking for "docker-compose molgenis" online, I first find the molgenis/docker package, with docker-compose.yml files that are different than the ones in molgenis-emx2. I find that our server-side Molgenis instance uses emx2, so for the local one I am doing the same.
  • When looking for molgenis-emx2 docker-compose, I find https://github.com/molgenis/molgenis-emx2/blob/master/docker-compose.yml.
  • Only after looking for documentation, I find the doc page with the link to the simpler version.

So, a developer might randomly end up on any of the above locations, and will have no idea what they should put in their docker-compose.yml.

It is also not clear to me from the README.md how the "EMX2" is different from the regular molgenis/molgenis.
Only after visiting the old repo I see that it is in archive mode.
But this is not mentioned in https://github.com/molgenis/docker/blob/master/README.md, which I assume also uses the archived version.

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

No branches or pull requests

1 participant