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

Documentation should detail contents more clearly #49

Open
maffettone opened this issue Mar 7, 2024 · 0 comments
Open

Documentation should detail contents more clearly #49

maffettone opened this issue Mar 7, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@maffettone
Copy link
Contributor

We should at least add a table to the readme of what containers are expected to be spun up, how they interact with each other, and what images they depend on. I can imagine the majority of applications will just execute the bash script and poke around, but a few may want to do some repurposing or extension. Even walking through the compose file, it took a bit of time for me to understand what was getting spun up, and from where.

@maffettone maffettone added the documentation Improvements or additions to documentation label Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant