a bit more guidance around the remove me after editing statements

Author: raphaeltm

starter-sample/.devcontainer/Dockerfile

@@ -1,6 +1,7 @@
 # Note: universal image is not compatible with the devcontainer tools.
 #       we use the typescript-node image instead here but should switch out per 
-#       project requirements. #REMOVE_ME_AFTER_EDITING
+#       project requirements. You can choose a devcontainer that's appropriate 
+#       for your sample from the list below #REMOVE_ME_AFTER_EDITING
 
 # FROM mcr.microsoft.com/devcontainers/go:1.22-bookworm
 # FROM mcr.microsoft.com/devcontainers/python:3.12-bookworm

starter-sample/.github/workflows/deploy.yaml

@@ -19,6 +19,7 @@ jobs:
     - name: Deploy
       uses: DefangLabs/[email protected]
       #REMOVE_ME_AFTER_EDITING - Replace the following line with the list of environment variables you want to pass to the action
+      # or remove the lines if you don't need to pass any environment variables/secrets to the action
       with:
         config-env-vars: ENV1 ENV2
       env:

starter-sample/app/.dockerignore

@@ -1,3 +1,3 @@
-#REMOVE_ME_AFTER_EDITING - This Dockerignore is for a basic node app. Modify as needed.
+#REMOVE_ME_AFTER_EDITING - This Dockerignore is for a basic node app. Modify as needed for your sample.
 node_modules
 npm-debug.log

starter-sample/app/.gitignore

@@ -1,2 +1,2 @@
-#REMOVE_ME_AFTER_EDITING - This Dockerignore is for a basic node app. Modify as needed.
+#REMOVE_ME_AFTER_EDITING - This Dockerignore is for a basic node app. Modify as needed for your sample.
 node_modules

starter-sample/app/Dockerfile

@@ -1,5 +1,5 @@
 # A sample dockerfile for a Node.js application.
-# Replace with an appropriate Dockerfile for your application.
+# Replace with an appropriate Dockerfile for your sample.
 #REMOVE_ME_AFTER_EDITING
 
 FROM node:20-bookworm-slim

starter-sample/app/index.js

@@ -1,3 +1,6 @@
+//#REMOVE_ME_AFTER_EDITING - This is a sample index.js file for a Node.js application.
+// Feel free to delete this file. It's just a placeholder.
+
 const express = require('express');
 const { MongoClient } = require('mongodb');
 

starter-sample/compose.dev.yaml

@@ -3,6 +3,10 @@
 # for samples where a user may want to hot reload changes in the app, or
 # if it depends on stateful services like a database that isn't supported
 # by Defang, like MongoDB.
+#
+# Note: This dev compose file's services should extend the production 
+# compose file's services. That way we can keep things consistent across
+# dev and production and override only what we need to.
 
 services:
   app: