cisagov / cisagov/skeleton-aws-lambda-python
Add documentation for the Docker Compose file
- Lenguaje dominante
- Shell
- Estrellas
- 6
- Forks
- 2
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
# 💡 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.
Guía de contribución
Línea de trabajo
Lee primero docker-compose.yml y después el README. Documenta las opciones de configuración de Compose, incluida la edición de docker-compose.yml y la sobrescritura de valores desde la línea de comandos, y explica su uso para compilar artefactos de Lambda o ejecutar Lambda localmente. Se habrá completado cuando el README contenga esta información y se haya satisfecho su elemento de la lista de comprobación.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- aws, docker-compose, python
- Área
- cloud, devops, documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100