Skip to content

chore: add Disclaimer for docker-based templates #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 13, 2025

Conversation

phorcys420
Copy link
Member

@phorcys420 phorcys420 commented Aug 12, 2025

This PR adds a production disclaimer to docker-build and updates the permission instructions for other Docker-based templates.

@Copilot Copilot AI review requested due to automatic review settings August 12, 2025 07:47
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds documentation improvements for Docker-based Coder templates, focusing on production usage guidance and installation scenarios. The changes provide clearer setup instructions for different deployment methods.

  • Adds production usage disclaimer for the docker-build template
  • Updates README files to distinguish between Docker-containerized and system package Coder installations
  • Standardizes Docker setup instructions across multiple template READMEs

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
registry/coder/templates/docker/README.md Restructures infrastructure section to cover both Docker and system installations
registry/coder/templates/docker-devcontainer/README.md Adds Docker installation guidance and updates command syntax
registry/coder-labs/templates/docker-build/README.md Adds production disclaimer and comprehensive Docker setup instructions

@phorcys420 phorcys420 requested a review from matifali August 12, 2025 07:49
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks Good, but can we also link our existing docs on how to use an external Docker host?
https://coder.com/docs/admin/templates/extending-templates/provider-authentication#use-a-remote-docker-host-for-authentication

@phorcys420
Copy link
Member Author

@matifali I think we link only to https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs#remote-hosts because that page you sent talks about external provisioners and i think will only cause confusion

@phorcys420 phorcys420 requested a review from matifali August 12, 2025 14:14
@phorcys420 phorcys420 changed the title phorcys420/docker build disclaimer chore: add Disclaimer for docker-based templates Aug 12, 2025
@DevelopmentCats
Copy link
Contributor

@phorcys420 you might need to 'bun run fmt' to format so the CI will pass.

@phorcys420 phorcys420 enabled auto-merge (squash) August 13, 2025 13:59
@phorcys420 phorcys420 merged commit 40863c0 into main Aug 13, 2025
4 checks passed
@phorcys420 phorcys420 deleted the phorcys420/docker-build-disclaimer branch August 13, 2025 14:03
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.

3 participants