guardian icon indicating copy to clipboard operation
guardian copied to clipboard

Review the list of docker-compose files in the repo

Open Neurone opened this issue 1 year ago • 0 comments

Problem description

The repo provides a variety of docker-compose files for building and starting Guardian. However, some of these files are not in sync with the most commonly used ones, which can lead to potential issues. Additionally, the purpose of these files is not clearly documented, making it difficult to understand their role in the setup.

docker-compose-DEV-ONLYSERVERS.yml
docker-compose-analytics.yml
docker-compose-aws.yml
docker-compose-dev.yml
docker-compose.yml
docker-composeRIL.yml
docker-compose_SSV.yml

Requirements

  • Review the list of docker-compose files so that:
    • If a file is not used anymore, delete it from the repo.
    • If the file has a reason to be there, verify the purpose in the documentation; if not, update the documentation accordingly.
  • Update the documentation with a summary table containing the docker compose's file name and a short description of its purpose.

Definition of done

  • The repo contains only used docker-compose files
  • The documentation explains the purpose of each docker-compose file

Neurone avatar Apr 18 '24 10:04 Neurone