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

Review the list of docker-compose files in the repo #3552

Open
Neurone opened this issue Apr 18, 2024 · 0 comments
Open

Review the list of docker-compose files in the repo #3552

Neurone opened this issue Apr 18, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Neurone
Copy link
Collaborator

Neurone commented Apr 18, 2024

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 Neurone added the enhancement New feature or request label Apr 18, 2024
@Neurone Neurone changed the title Review the list of docker-compose files in the repo. Review the list of docker-compose files in the repo Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant