Explain deployment artifacts and their supported roles
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 88/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- aws, docker-compose, terraform
- 领域
- cloud, devops, documentation
调研方向
在当前 main 上阅读 docs/src/content/docs/guides/deployment.md、docs/src/content/docs/reference/text.md、docs/astro.config.mjs 和 example.env，以 audit 9d8ac3e01df1 作为起点。仅创建 docs/src/content/docs/guides/roadmap/ecs-vs-compose.md，区分已交付的工件与由操作员负责的 AWS 设置，并涵盖缓存和可写存储的需求，但不要将 Terraform 描述为可用。运行 npm --prefix docs ci、npm --prefix docs run build 和 git diff --check。
由索引模型根据 Issue 内容生成。
描述
DOC-12 · Documentation and accessibility
Difficulty: beginner · Status: ready
This is a focused contribution against current main. No unmerged feature PR is required.
Why this is useful
Compose is implemented while ECS setup is largely guidance
Start here
Source audit: 9d8ac3e01df1. Read these files on current main too, because paths may change after the audit:
docs/astro.config.mjsdocs/src/content/docs/reference/text.mddocs/src/content/docs/guides/deployment.mdexample.env
Scope and intended output
Write docs/src/content/docs/guides/roadmap/ecs-vs-compose.md; keep this contribution in its own page. Maintainers can add navigation links after merge to avoid concurrent sidebar edits.
Acceptance criteria
- List what the repo actually ships versus operator-owned AWS setup
- Explain cache and writable-storage needs
- Do not present future Terraform as available
Verification
npm --prefix docs ci
npm --prefix docs run build
git diff --check
Build the docs site locally. Verify the described commands against current source; explicitly report platform steps you could not execute. Do not run paid examples as a build check.
Dependencies
None. Keep the PR based on current upstream main.
Out of scope
- Unrelated refactors, broad formatting, endpoint renames, or extra dependencies without agreement.
- Live cloud provisioning, paid model calls, real private messages, or credentials in fixtures/logs.
- Implementing neighboring roadmap issues in the same PR.
Getting help and submitting
Comment with your intended approach and ask when expected behavior is unclear. Check for an existing PR before starting; there is no deadline for a volunteer contribution. A useful reproduction or partial finding is welcome.
Use the issue's criteria as the review checklist. Include the commands actually run and any limitations. Link the issue; use Fixes only when its entire agreed scope is complete. If CONTRIBUTING.md is not yet on main, the contributor-roadmap PR provides the onboarding guide.
- 主要语言
- Python
- 星标
- 3
- 派生
- 10
- 平均合并
- 8 小时 11 分钟
- 30 天内合并 PR
- 18
环境准备
我们还没有检查这个项目的环境配置文件。先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
ashrafee-dev/scamshield-api 的其他 Issue
-
area:testing contributor-roadmap difficulty:intermediate help wanted status:ready
难度 2/5 1-3 小时 新手友好度 78/100
ashrafee-dev/scamshield-api#291 ·
维护者通常 1 天内回复
-
area:docs contributor-roadmap difficulty:beginner documentation good first issue help wanted status:ready
难度 2/5 半天 新手友好度 84/100
ashrafee-dev/scamshield-api#287 ·
维护者通常 1 天内回复
-
area:docs contributor-roadmap difficulty:beginner documentation good first issue help wanted status:ready
难度 2/5 半天 新手友好度 84/100
ashrafee-dev/scamshield-api#286 ·
维护者通常 1 天内回复
-
area:docs contributor-roadmap difficulty:beginner documentation good first issue help wanted status:ready
难度 2/5 1-3 小时 新手友好度 86/100
ashrafee-dev/scamshield-api#285 ·
维护者通常 1 天内回复
-
area:docs contributor-roadmap difficulty:beginner documentation good first issue help wanted status:ready
难度 2/5 1-3 小时 新手友好度 88/100
ashrafee-dev/scamshield-api#283 ·
维护者通常 1 天内回复
查看 ashrafee-dev/scamshield-api 的全部 Issue
相似的 Issue
-
docs(types): update the collection binding note now that typed collections shipped in pycubrid 1.9.0未关闭documentation priority: low size: S
难度 2/5 1-3 小时 新手友好度 75/100
cubrid-lab/sqlalchemy-cubrid#768 ·
维护者通常 1 天内回复
-
bug help wanted
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
documentation
难度 1/5 1 小时以内 新手友好度 65/100
ansys/pydpf-core#3547 ·
维护者通常 1 天内回复
-
core
难度 2/5 1-3 小时 新手友好度 70/100
vectorize-io/hindsight#5457 ·
维护者通常 1 天内回复
-
[Bug]: LangChain drops OpenAI Responses text blocks from session recording可能已有人在做 @ktz03 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
volcengine/OpenViking#5806 ·
维护者通常 1 天内回复