cisagov / cisagov/skeleton-aws-lambda-python

Add documentation for the Docker Compose file

Open
#26 0 comments 0 reactions 0 assignees View on GitHub
documentation improvement
Dominant language
Shell
Stars
6
Forks
2
PR merge metrics
No merged PRs in 30d

Description

# 💡 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 https://github.com/cisagov/publish-egress-ip-lambda/pull/4#discussion_r1608714477 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.