edits to docker compose comments

Author: travisamartin

static/scripts/docker-compose/docker-compose-lightweight.yaml

@@ -2,10 +2,10 @@ name: nim
 secrets:
   nim_admin_password:
     file: admin_password.txt
-  # Optional - set admin and user credential from .htpasswd file
+  # Optional: set admin and user credentials from a .htpasswd file.
   #nim_credential_file:
   #  file: nim_creds.txt
-  # Optional - set the external SSL cert, key and ca in PEM format for the nim ingress proxy
+  # Optional: set external SSL certificate, key, and CA in PEM format for the NIM ingress proxy.
   #nim_proxy_cert_file:
   #  file: ./certs/nim_cert.pem
   #nim_proxy_cert_key:
@@ -23,7 +23,7 @@ services:
     volumes:
       - nim-data:/data
       - proxy-certs:/usr/local/share/ca-certificates
-    # Uncomment to set custom service limits
+    # Uncomment to set custom service limits.
     #deploy:
     #  resources:
     #    limits:
@@ -38,51 +38,51 @@ services:
     stop_grace_period: 30s
     secrets:
       - nim_admin_password
-      # Uncomment the line below if using a .htpasswd credential file. The credential file takes priority over the nim_admin_password file
+      # Uncomment this line if you use a .htpasswd credential file. The credential file takes priority over the nim_admin_password file.
       #- nim_credential_file
-      # Uncomment the lines below if using user provided cert, key and CA for the nim ingress proxy
+      # Uncomment these lines to use user-provided certificate, key, and CA for the NIM ingress proxy.
       #- nim_proxy_cert_file
       #- nim_proxy_cert_key
       #- nim_proxy_ca_cert
     environment:
-      # set the NIM logging level
+      # Set the NIM logging level.
       NIM_LOG_LEVEL: "INFO"
-      # set a custom time-to-live in days value for metrics retention
+      # Set a custom time-to-live value (in days) for metrics retention.
       NIM_METRICS_TTL: "1"
-      # set a custom time-to-live in days value for events retention
+      # Set a custom time-to-live value (in days) for event retention.
       NIM_EVENTS_TTL: "1"
-      # set a custom time-to-live in days value for security violation retention
+      # Set a custom time-to-live value (in days) for security violation retention.
       NIM_SECURITY_TTL: "1"
-      # enable maintenance mode to preform backup,restore and troubleshooting
+      # Enable maintenance mode to perform backup, restore, and troubleshooting.
       #NIM_MAINTENANCE: "true"
-      # set a custom watchdog timeout in seconds.
+      # Set a custom watchdog timeout (in seconds).
       NIM_WATCHDOG_TIMEOUT: "60"
-      # set the NIM license mode of operation to either connected or disconnected. Default is connected.
+      # Set the NIM license mode to connected or disconnected. Default is connected.
       NIM_LICENSE_MODE_OF_OPERATION: "connected"
-      # Enable this setting to use proxy
+      # Enable basic proxy support.
       PROXY_ENABLE: false
-      # Configure this setting to set the host of the proxy server to be used
+      # Configure the proxy server host.
       PROXY_HOST: ""
-      # Configure this setting to set the protocol of the proxy server to be used - http/https (default - http)
+      # Configure the proxy server protocol (http or https). Default is http.
       PROXY_PROTOCOL: "http"
-      # Configure this setting to set the port of the proxy server to be used
+      # Configure the proxy server port.
       PROXY_PORT: 3128
-      # Enable this setting to use basic auth for proxy
+      # Enable basic authentication for the proxy.
       PROXY_AUTH_REQUIRED: false
-      # Configure this setting to set the user name in basic auth (proxy_auth_required: true)
+      # Configure proxy username for basic authentication (required when proxy_auth_required is true).
       PROXY_AUTH_USERNAME: ""
-      # Configure this setting to set the password in basic auth (proxy_auth_required: true)
-      # Recommended to use .env file for the password
+      # Configure proxy password for basic authentication (required when proxy_auth_required is true).
+      # We recommend using a .env file for the password.
       # PROXY_PASSWORD: ""
-      # Configure this setting to set the proxy connection verification (is the proxy trusted by the host)
+      # Configure proxy SSL verification to trust the proxy server.
       PROXY_SSL_VERIFY: true
       ENABLE_METRICS: false
 networks:
   external_network:
     driver: bridge
 volumes:
-  # By default docker compose will create a named volume
-  # Refer to https://docs.docker.com/reference/compose-file/volumes/ for additional storage options such as nfs
+  # By default, Docker Compose creates a named volume.
+  # For additional storage options such as NFS, see https://docs.docker.com/reference/compose-file/volumes/.
   proxy-certs:
     driver: local
   nim-data: