From d102144746a59517769d2b8f644c5d978233e8f2 Mon Sep 17 00:00:00 2001 From: Michael G Date: Sun, 30 May 2021 18:56:35 +0200 Subject: [PATCH 1/2] :book: Fix typos and rephrase some comments Minor typos and the names of official services corrected in comments. --- docker/images/config.env | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docker/images/config.env b/docker/images/config.env index 79f1472ee..396ce8cf9 100644 --- a/docker/images/config.env +++ b/docker/images/config.env @@ -1,8 +1,8 @@ -# Should be set to the public domain when penpot is going to be +# Should be set to the public domain where penpot is going to be # served. PENPOT_PUBLIC_URI=http://localhost:9001 -# Standard database connection parametes (only postgresql is +# Standard database connection parameters (only postgresql is # supported): PENPOT_DATABASE_URI=postgresql://penpot-postgres/penpot PENPOT_DATABASE_USERNAME=penpot @@ -11,22 +11,22 @@ PENPOT_DATABASE_PASSWORD=penpot # Redis is used for the websockets notifications. PENPOT_REDIS_URI=redis://penpot-redis/0 -# By default files upload by user are stored in local filesystem. But -# it can be configured to store in AWS S3 or completelly in de the +# By default, files uploaded by users are stored in local filesystem. But +# it can be configured to store in AWS S3 or completely in de the # database. Storing in the database makes the backups more easy but # will make access to media less performant. PENPOT_STORAGE_BACKEND=fs PENPOT_STORAGE_FS_DIRECTORY=/opt/data/assets -# Telemetry. When enabled, a periodical process will send annonymous +# Telemetry. When enabled, a periodical process will send anonymous # data about this instance. Telemetry data will enable us to learn on -# how the application is used based on real scenarios. If you want to +# how the application is used, based on real scenarios. If you want to # help us, please leave it enabled. PENPOT_TELEMETRY_ENABLED=true -# Email sending configuration. By default emails are printed in -# console, but for production usage is recommeded to setup a real SMTP -# provider. Emails are used for confirm user registration. +# Email sending configuration. By default, emails are printed in the +# console, but for production usage is recommended to setup a real SMTP +# provider. Emails are used to confirm user registrations. PENPOT_SMTP_ENABLED=false PENPOT_SMTP_DEFAULT_FROM=no-reply@example.com PENPOT_SMTP_DEFAULT_REPLY_TO=no-reply@example.com @@ -40,7 +40,7 @@ PENPOT_SMTP_DEFAULT_REPLY_TO=no-reply@example.com # Enable or disable external user registration process. PENPOT_REGISTRATION_ENABLED=true -# Comma separated list of allowed domains to register. Empty for allow +# Comma separated list of allowed domains to register. Empty to allow # all. # PENPOT_REGISTRATION_DOMAIN_WHITELIST="" @@ -55,11 +55,11 @@ PENPOT_ALLOW_DEMO_USERS=true # PENPOT_GOOGLE_CLIENT_ID= # PENPOT_GOOGLE_CLIENT_SECRET= -# Github +# GitHub # PENPOT_GITHUB_CLIENT_ID= # PENPOT_GITHUB_CLIENT_SECRET= -# Gitlab +# GitLab # PENPOT_GITLAB_BASE_URI=https://gitlab.com # PENPOT_GITLAB_CLIENT_ID= # PENPOT_GITLAB_CLIENT_SECRET= From 9d54f71dbb3c67a48ddadb3c35ef492d55a8fdcb Mon Sep 17 00:00:00 2001 From: Michael G Date: Sun, 30 May 2021 19:02:26 +0200 Subject: [PATCH 2/2] :books: Align comments to 80 characters I did not find any style recommendation that states an exact line length. Assuming a common value of 80, this leads to less lines being split. --- docker/images/config.env | 36 ++++++++++++++++-------------------- 1 file changed, 16 insertions(+), 20 deletions(-) diff --git a/docker/images/config.env b/docker/images/config.env index 396ce8cf9..6d1f76bd2 100644 --- a/docker/images/config.env +++ b/docker/images/config.env @@ -1,9 +1,7 @@ -# Should be set to the public domain where penpot is going to be -# served. +# Should be set to the public domain where penpot is going to be served. PENPOT_PUBLIC_URI=http://localhost:9001 -# Standard database connection parameters (only postgresql is -# supported): +# Standard database connection parameters (only postgresql is supported): PENPOT_DATABASE_URI=postgresql://penpot-postgres/penpot PENPOT_DATABASE_USERNAME=penpot PENPOT_DATABASE_PASSWORD=penpot @@ -11,22 +9,22 @@ PENPOT_DATABASE_PASSWORD=penpot # Redis is used for the websockets notifications. PENPOT_REDIS_URI=redis://penpot-redis/0 -# By default, files uploaded by users are stored in local filesystem. But -# it can be configured to store in AWS S3 or completely in de the -# database. Storing in the database makes the backups more easy but -# will make access to media less performant. +# By default, files uploaded by users are stored in local filesystem. But it +# can be configured to store in AWS S3 or completely in de the database. +# Storing in the database makes the backups more easy but will make access to +# media less performant. PENPOT_STORAGE_BACKEND=fs PENPOT_STORAGE_FS_DIRECTORY=/opt/data/assets -# Telemetry. When enabled, a periodical process will send anonymous -# data about this instance. Telemetry data will enable us to learn on -# how the application is used, based on real scenarios. If you want to -# help us, please leave it enabled. +# Telemetry. When enabled, a periodical process will send anonymous data about +# this instance. Telemetry data will enable us to learn on how the application +# is used, based on real scenarios. If you want to help us, please leave it +# enabled. PENPOT_TELEMETRY_ENABLED=true -# Email sending configuration. By default, emails are printed in the -# console, but for production usage is recommended to setup a real SMTP -# provider. Emails are used to confirm user registrations. +# Email sending configuration. By default, emails are printed in the console, +# but for production usage is recommended to setup a real SMTP provider. Emails +# are used to confirm user registrations. PENPOT_SMTP_ENABLED=false PENPOT_SMTP_DEFAULT_FROM=no-reply@example.com PENPOT_SMTP_DEFAULT_REPLY_TO=no-reply@example.com @@ -40,13 +38,12 @@ PENPOT_SMTP_DEFAULT_REPLY_TO=no-reply@example.com # Enable or disable external user registration process. PENPOT_REGISTRATION_ENABLED=true -# Comma separated list of allowed domains to register. Empty to allow -# all. +# Comma separated list of allowed domains to register. Empty to allow all. # PENPOT_REGISTRATION_DOMAIN_WHITELIST="" # Penpot comes with the facility to create quick demo users that are -# automatically deleted after some time. This settings enables or -# disables the creation of demo users. +# automatically deleted after some time. This settings enables or disables the +# creation of demo users. PENPOT_ALLOW_DEMO_USERS=true ## Authentication providers @@ -82,4 +79,3 @@ PENPOT_ALLOW_DEMO_USERS=true # PENPOT_LDAP_ATTRS_FULLNAME=cn # PENPOT_LDAP_ATTRS_PHOTO=jpegPhoto # PENPOT_LOGIN_WITH_LDAP=true -