cisagov / cisagov/skeleton-aws-lambda-python

Add documentation for the Docker Compose file

Aperta
#26 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
documentation improvement
Lingua principale
Shell
Stelle
6
Fork
2
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

# 💡 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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Leggi prima docker-compose.yml, quindi il README. Documenta le opzioni di configurazione di Compose, inclusa la modifica di docker-compose.yml e la sovrascrittura dei valori dalla riga di comando, e spiega il suo utilizzo per creare artefatti Lambda o eseguire Lambda localmente. Il lavoro è completato quando il README contiene queste informazioni e il relativo elemento della checklist è soddisfatto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
aws, docker-compose, python
Ambito
cloud, devops, documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.