Skip to content

docs: quickstartにDocker Hubイメージ/独自Dockerfileの選択肢を追記#5

Merged
takemi-ohama merged 2 commits intomainfrom
docs-quickstart-context-paths
May 1, 2026
Merged

docs: quickstartにDocker Hubイメージ/独自Dockerfileの選択肢を追記#5
takemi-ohama merged 2 commits intomainfrom
docs-quickstart-context-paths

Conversation

@takemi-ohama
Copy link
Copy Markdown
Contributor

@takemi-ohama takemi-ohama commented May 1, 2026

Pull Request

概要

docs/plugin-dev/quickstart.md の「2.2 compose.yml の作成」ポイント説明が「build.context\${DEVBASE_ROOT} ベース」のみを許容するように読めていたため、標準コンテナを使う場合に限定する旨を明示。あわせて、Docker Hub などの公開イメージ参照や、独自 Dockerfile を利用する構成も可能であることを追記する。

compose-yml-guidelines.md §1.2 / §4.3 との整合も取り、独自 Dockerfile は \${DEVBASE_ROOT}/plugins/<plugin>/ 配下に配置する旨を記載。

関連 Issue

  • Closes #

変更点

  • docs/plugin-dev/quickstart.md L90:
    • 文頭に「標準コンテナを使う場合は、」を追加
    • image: のみ指定して build: を省略する選択肢を追記(Docker Hub 等の公開イメージ)
    • 独自 Dockerfile は \${DEVBASE_ROOT}/plugins/<plugin>/ 配下に配置するよう案内(projects/ 直下はシンボリックリンクのため context: . 不可)
    • 詳細は [compose.yml ガイドライン §4.3] へ誘導

やらないこと

  • compose-yml-guidelines.md 側の更新(既存記述で整合済み、本PRでは未変更)

動作確認

  • 既存ユーザーが従来通り \${DEVBASE_ROOT}/containers/... でビルドできる
  • Docker Hub イメージのみで動作するプロジェクトが作成できる
  • \${DEVBASE_ROOT}/plugins/<plugin>/ 配下の独自 Dockerfile を参照する compose.yml が動作する
  • CI が green である

takemi-ohama and others added 2 commits May 2, 2026 07:29
build.context の説明を「標準コンテナを使う場合」に限定し、
公開イメージ参照(image: のみ)や独自Dockerfile(context: .)も
利用可能であることを追記。

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
projects/<project>/ はシンボリックリンクで context: . が安定しないため、
独自Dockerfileは ${DEVBASE_ROOT}/plugins/<plugin>/ 配下に置く案内に修正。
compose.yml ガイドライン §1.2 / §4.3 と整合。

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@takemi-ohama takemi-ohama force-pushed the docs-quickstart-context-paths branch from c9c336e to 98a9d81 Compare May 1, 2026 22:29
@takemi-ohama takemi-ohama merged commit 94b5bed into main May 1, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant