cisagov / cisagov/skeleton-aws-lambda-python

Add documentation for the Docker Compose file

未關閉
#26 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
documentation improvement
主要語言
Shell
星號
6
分支
2
PR 合併指標
30 天內沒有已合併 PR

描述

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

貢獻指南

開啟貢獻指南

研究方向

先閱讀 docker-compose.yml,然後閱讀 README。記錄 Compose 設定選項,包括編輯 docker-compose.yml 以及從命令列覆寫值,並說明如何使用它來建置 Lambda 成品或在本機執行 Lambda。當 README 包含這些資訊且其檢查清單項目已滿足時,即表示完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
aws, docker-compose, python
領域
cloud, devops, documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。