cisagov / cisagov/skeleton-aws-lambda-python

Add documentation for the Docker Compose file

Aberta
#26 0 comentários 0 reações 0 responsáveis Ver no GitHub
documentation improvement
Linguagem predominante
Shell
Estrelas
6
Forks
2
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Leia primeiro o docker-compose.yml e, em seguida, o README. Documente as opções de configuração do Compose, incluindo a edição do docker-compose.yml e a substituição de valores pela linha de comando, e explique seu uso para criar artefatos do Lambda ou executar o Lambda localmente. Está concluído quando o README contiver essas informações e seu item da checklist estiver satisfeito.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
aws, docker-compose, python
Domínio
cloud, devops, documentation
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.