Merge pull request #269 from os2display/feature/developer-docs

Updated developer docs

Author: tuj

.env

@@ -39,31 +39,40 @@ CORS_ALLOW_ORIGIN='^https?://(localhost|127\.0\.0\.1)(:[0-9]+)?$'
 # CORS_ALLOW_ORIGIN="^.*"
 ###< nelmio/cors-bundle ###
 
-###> App ###
-APP_DEFAULT_DATE_FORMAT='Y-m-d\TH:i:s.v\Z'
-APP_ACTIVATION_CODE_EXPIRE_INTERNAL=P2D
-APP_KEY_VAULT_SOURCE=ENVIRONMENT
-APP_KEY_VAULT_JSON="{}"
-###< App ###
-
 ###> lexik/jwt-authentication-bundle ###
 JWT_SECRET_KEY=%kernel.project_dir%/config/jwt/private.pem
 JWT_PUBLIC_KEY=%kernel.project_dir%/config/jwt/public.pem
 JWT_PASSPHRASE=APP_JWT_PASSPHRASE
-# 1 hour
+# Default: 1 hour
 JWT_TOKEN_TTL=3600
-# 15 days
+# Default: 15 days
 JWT_SCREEN_TOKEN_TTL=1296000
 ###< lexik/jwt-authentication-bundle ###
 
 ###> gesdinet/jwt-refresh-token-bundle ###
-# 2 hours
+# Default: 2 hours
 JWT_REFRESH_TOKEN_TTL=7200
-# 30 days
+# Default: 30 days
 JWT_SCREEN_REFRESH_TOKEN_TTL=2592000
 ###< gesdinet/jwt-refresh-token-bundle ###
 
+###> redis ###
+REDIS_CACHE_PREFIX=DisplayApiService
+REDIS_CACHE_DSN=redis://redis:6379/0
+###< redis ###
+
+###> App ###
+APP_DEFAULT_DATE_FORMAT='Y-m-d\TH:i:s.v\Z'
+APP_ACTIVATION_CODE_EXPIRE_INTERVAL=P2D
+APP_KEY_VAULT_SOURCE=ENVIRONMENT
+APP_KEY_VAULT_JSON="{}"
+EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS=300
+TRACK_SCREEN_INFO=false
+TRACK_SCREEN_INFO_UPDATE_INTERVAL_SECONDS=300
+###< App ###
+
 ###> itk-dev/openid-connect-bundle ###
+# See docs/feed/openid-connect.md for variable explanations.
 # internal provider
 INTERNAL_OIDC_METADATA_URL=INTERNAL_OIDC_METADATA_URL
 INTERNAL_OIDC_CLIENT_ID=INTERNAL_OIDC_CLIENT_ID
@@ -82,19 +91,13 @@ EXTERNAL_OIDC_REDIRECT_URI=EXTERNAL_OIDC_REDIRECT_URI
 EXTERNAL_OIDC_LEEWAY=30
 EXTERNAL_OIDC_HASH_SALT=
 EXTERNAL_OIDC_CLAIM_ID=signinname
-###< itk-dev/openid-connect-bundle ###
 
 # cli redirect url
 OIDC_CLI_REDIRECT=APP_CLI_REDIRECT_URI
 ###< itk-dev/openid-connect-bundle ###
 
-###> redis ###
-REDIS_CACHE_PREFIX=DisplayApiService
-REDIS_CACHE_DSN=redis://redis:6379/0
-###< redis ###
-
 ###> Calendar Api Feed Source ###
-# See docs/feed/calendar-api-feed.md for variable explainations.
+# See docs/feed/calendar-api-feed.md for variable explanations.
 CALENDAR_API_FEED_SOURCE_LOCATION_ENDPOINT=
 CALENDAR_API_FEED_SOURCE_RESOURCE_ENDPOINT=
 CALENDAR_API_FEED_SOURCE_EVENT_ENDPOINT=
@@ -105,13 +108,7 @@ CALENDAR_API_FEED_SOURCE_DATE_TIMEZONE=
 CALENDAR_API_FEED_SOURCE_CACHE_EXPIRE_SECONDS=300
 ###< Calendar Api Feed Source ###
 
-EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS=300
-
-TRACK_SCREEN_INFO=false
-TRACK_SCREEN_INFO_UPDATE_INTERVAL_SECONDS=300
-
 ###> Admin configuration ###
-### Will be injected in the html of the admin page.
 ADMIN_REJSEPLANEN_APIKEY=
 ADMIN_SHOW_SCREEN_STATUS=false
 ADMIN_TOUCH_BUTTON_REGIONS=false
@@ -120,13 +117,11 @@ ADMIN_ENHANCED_PREVIEW=false
 ###< Admin configuration ###
 
 ###> Client configuration ###
-### Will be injected in the html of the client page.
 CLIENT_LOGIN_CHECK_TIMEOUT=20000
 CLIENT_REFRESH_TOKEN_TIMEOUT=300000
 CLIENT_RELEASE_TIMESTAMP_INTERVAL_TIMEOUT=600000
 CLIENT_SCHEDULING_INTERVAL=60000
 CLIENT_PULL_STRATEGY_INTERVAL=90000
 CLIENT_COLOR_SCHEME='{"type":"library","lat":56.0,"lng":10.0}'
 CLIENT_DEBUG=false
-CLIENT_LOGGING='[]'
 ###< Client configuration ###

CHANGELOG.md

@@ -14,14 +14,15 @@ All notable changes to this project will be documented in this file.
 * Removed propTypes.
 * Upgraded redux-toolkit and how api slices are generated.
 * Fixed redux-toolkit cache handling.
-* Add Taskfile
+* Added Taskfile
+* Updated developer documentation.
 
 ### NB! Prior to 3.x the project was split into separate repositories
 
-Therefore, changelogs were maintained for each repo. These are available here:
+Therefore, changelogs were maintained for each repo. The v2 changelogs have been moved to the `docs/v2-changelogs/`
+folder.
 
-* API: [docs/changelogs/api.md](docs/changelogs/api.md)
-* Admin: [docs/changelogs/admin.md](docs/changelogs/admin.md)
-* Template: [docs/changelogs/template.md](docs/changelogs/template.md)
-* Client: [docs/changelogs/client.md](docs/changelogs/client.md)
-* Docs: [docs/changelogs/docs.md](docs/changelogs/docs.md)
+* API: [docs/v2-changelogs/api.md](docs/v2-changelogs/api.md)
+* Admin: [docs/v2-changelogs/admin.md](docs/v2-changelogs/admin.md)
+* Template: [docs/v2-changelogs/template.md](docs/v2-changelogs/template.md)
+* Client: [docs/v2-changelogs/client.md](docs/v2-changelogs/client.md)