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

Add documentation for the Docker Compose file #26

Open
1 task
mcdonnnj opened this issue May 23, 2024 · 0 comments
Open
1 task

Add documentation for the Docker Compose file #26

mcdonnnj opened this issue May 23, 2024 · 0 comments
Labels
documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use

Comments

@mcdonnnj
Copy link
Member

💡 Summary

It would be helpful to add some documentation that explains the configuration options of the Docker Compose file used to generate Lambda artifacts (or run the Lambda locally).

Motivation and context

This was suggested in cisagov/publish-egress-ip-lambda#4 (comment) and would generally be useful.

Implementation notes

Modifying the docker-compose.yml file itself should be mentioned but so should overriding things on the command line.

Acceptance criteria

How do we know when this work is done?

  • The project's README provides information on the Docker Compose file that is used to build Lambda artifacts.
@mcdonnnj mcdonnnj added documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use labels May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
Development

No branches or pull requests

1 participant