[#2426] Update docs for cms configuration steps

maykinmedia · Jul 16, 2024 · b5b403a · b5b403a
1 parent bb5e71f
commit b5b403a
Show file tree

Hide file tree

Showing 15 changed files with 36 additions and 22 deletions.
diff --git a/docs/configuration/admin_oidc.rst b/docs/configuration/admin_oidc.rst
@@ -82,7 +82,7 @@ Detailed Information
     Variable            ADMIN_OIDC_OIDC_EXEMPT_URLS
     Setting             URLs exempt from session renewal
     Description         This is a list of absolute url paths, regular expressions for url paths, or Django view names. This plus the mozilla-django-oidc urls are exempted from the session renewal by the SessionRefresh middleware.
-    Possible values     No information available
+    Possible values     string, comma-delimited ('foo,bar,baz')
     Default value       
     
     Variable            ADMIN_OIDC_OIDC_NONCE_SIZE
@@ -142,7 +142,7 @@ Detailed Information
     Variable            ADMIN_OIDC_OIDC_RP_SCOPES_LIST
     Setting             OpenID Connect scopes
     Description         OpenID Connect scopes that are requested during login
-    Possible values     No information available
+    Possible values     string, comma-delimited ('foo,bar,baz')
     Default value       openid, email, profile
     
     Variable            ADMIN_OIDC_OIDC_RP_SIGN_ALGO
@@ -166,7 +166,7 @@ Detailed Information
     Variable            ADMIN_OIDC_SUPERUSER_GROUP_NAMES
     Setting             Superuser group names
     Description         If any of these group names are present in the claims upon login, the user will be marked as a superuser. If none of these groups are present the user will lose superuser permissions.
-    Possible values     No information available
+    Possible values     string, comma-delimited ('foo,bar,baz')
     Default value       
     
     Variable            ADMIN_OIDC_SYNC_GROUPS

diff --git a/docs/configuration/cms_cases.rst b/docs/configuration/cms_cases.rst
@@ -13,7 +13,7 @@ Enable/Disable configuration:
 
 ::
 
-    CMS_CASES_CONFIG_ENABLE
+    CMS_CONFIG_CASES_ENABLE
 
 
 

diff --git a/docs/configuration/cms_collaborate.rst b/docs/configuration/cms_collaborate.rst
@@ -13,7 +13,7 @@ Enable/Disable configuration:
 
 ::
 
-    CMS_COLLABORATE_CONFIG_ENABLE
+    CMS_CONFIG_COLLABORATE_ENABLE
 
 
 

diff --git a/docs/configuration/cms_inbox.rst b/docs/configuration/cms_inbox.rst
@@ -13,7 +13,7 @@ Enable/Disable configuration:
 
 ::
 
-    CMS_INBOX_CONFIG_ENABLE
+    CMS_CONFIG_INBOX_ENABLE
 
 
 

diff --git a/docs/configuration/cms_products.rst b/docs/configuration/cms_products.rst
@@ -13,7 +13,7 @@ Enable/Disable configuration:
 
 ::
 
-    CMS_PRODUCTS_CONFIG_ENABLE
+    CMS_CONFIG_PRODUCTS_ENABLE
 
 
 

diff --git a/docs/configuration/cms_profile.rst b/docs/configuration/cms_profile.rst
@@ -13,7 +13,7 @@ Enable/Disable configuration:
 
 ::
 
-    CMS_PROFILE_CONFIG_ENABLE
+    CMS_CONFIG_PROFILE_ENABLE
 
 
 
@@ -23,10 +23,21 @@ All settings:
 
 ::
 
+    CMS_PROFILE_ACTIONS
+    CMS_PROFILE_APPOINTMENTS
+    CMS_PROFILE_MENTORS
     CMS_PROFILE_MENU_ICON
     CMS_PROFILE_MENU_INDICATOR
+    CMS_PROFILE_MY_CONTACTS
+    CMS_PROFILE_MY_DATA
+    CMS_PROFILE_NEWSLETTERS
+    CMS_PROFILE_NOTIFICATIONS
+    CMS_PROFILE_QUESTIONS
     CMS_PROFILE_REQUIRES_AUTH
     CMS_PROFILE_REQUIRES_AUTH_BSN_OR_KVK
+    CMS_PROFILE_SELECTED_CATEGORIES
+    CMS_PROFILE_SELFDIAGNOSE
+    CMS_PROFILE_SSD
 
 Detailed Information
 ====================

diff --git a/docs/configuration/cms_ssd.rst b/docs/configuration/cms_ssd.rst
@@ -13,7 +13,7 @@ Enable/Disable configuration:
 
 ::
 
-    CMS_SSD_CONFIG_ENABLE
+    CMS_CONFIG_SSD_ENABLE
 
 
 

diff --git a/docs/configuration/digid_saml.rst b/docs/configuration/digid_saml.rst
@@ -92,13 +92,13 @@ Detailed Information
     Variable            DIGID_SAML_CERTIFICATE_PRIVATE_KEY
     Setting             private key
     Description         The content of the private key
-    Possible values     No information available
+    Possible values     string representing the (absolute) path to a file, including file extension
     Default value       No default
     
     Variable            DIGID_SAML_CERTIFICATE_PUBLIC_CERTIFICATE
     Setting             public certificate
     Description         The content of the certificate
-    Possible values     No information available
+    Possible values     string representing the (absolute) path to a file, including file extension
     Default value       No default
     
     Variable            DIGID_SAML_CERTIFICATE_TYPE

diff --git a/docs/configuration/eherkenning_oidc.rst b/docs/configuration/eherkenning_oidc.rst
@@ -78,7 +78,7 @@ Detailed Information
     Variable            EHERKENNING_OIDC_OIDC_EXEMPT_URLS
     Setting             URLs exempt from session renewal
     Description         This is a list of absolute url paths, regular expressions for url paths, or Django view names. This plus the mozilla-django-oidc urls are exempted from the session renewal by the SessionRefresh middleware.
-    Possible values     No information available
+    Possible values     string, comma-delimited ('foo,bar,baz')
     Default value       
     
     Variable            EHERKENNING_OIDC_OIDC_KEYCLOAK_IDP_HINT
@@ -150,7 +150,7 @@ Detailed Information
     Variable            EHERKENNING_OIDC_OIDC_RP_SCOPES_LIST
     Setting             OpenID Connect scopes
     Description         OpenID Connect-scopes die worden bevraagd tijdens het inloggen. Deze zijn hardcoded en moeten worden ondersteund door de identiteitsprovider.
-    Possible values     No information available
+    Possible values     string, comma-delimited ('foo,bar,baz')
     Default value       openid, kvk
     
     Variable            EHERKENNING_OIDC_OIDC_RP_SIGN_ALGO

diff --git a/docs/configuration/eherkenning_saml.rst b/docs/configuration/eherkenning_saml.rst
@@ -105,13 +105,13 @@ Detailed Information
     Variable            EHERKENNING_SAML_CERTIFICATE_PRIVATE_KEY
     Setting             private key
     Description         The content of the private key
-    Possible values     No information available
+    Possible values     string representing the (absolute) path to a file, including file extension
     Default value       No default
     
     Variable            EHERKENNING_SAML_CERTIFICATE_PUBLIC_CERTIFICATE
     Setting             public certificate
     Description         The content of the certificate
-    Possible values     No information available
+    Possible values     string representing the (absolute) path to a file, including file extension
     Default value       No default
     
     Variable            EHERKENNING_SAML_CERTIFICATE_TYPE

diff --git a/src/open_inwoner/conf/app/setup_configuration.py b/src/open_inwoner/conf/app/setup_configuration.py
@@ -25,7 +25,7 @@
 OIP_ORGANIZATION = config("OIP_ORGANIZATION", "")
 
 # ZGW configuration variables
-ZGW_ENABLE = config("ZGW_ENABLE", default=True)
+ZGW_CONFIG_ENABLE = config("ZGW_ENABLE", default=True)
 ZGW_SERVER_CERTIFICATE_LABEL = config("ZGW_SERVER_CERTIFICATE_LABEL", "")
 ZGW_SERVER_CERTIFICATE_TYPE = config("ZGW_SERVER_CERTIFICATE_TYPE", "")
 ZGW_SERVER_CERTIFICATE_PUBLIC_CERTIFICATE = (

diff --git a/src/open_inwoner/conf/base.py b/src/open_inwoner/conf/base.py
@@ -977,11 +977,11 @@
     },
     {
         "field": "django.db.models.fields.files.FileField",
-        "description": "string represeting the (absolute) path to a file, including file extension",
+        "description": "string representing the (absolute) path to a file, including file extension",
     },
     {
         "field": "privates.fields.PrivateMediaFileField",
-        "description": "string represeting the (absolute) path to a file, including file extension",
+        "description": "string representing the (absolute) path to a file, including file extension",
     },
 ]
 

diff --git a/src/open_inwoner/conf/locale/nl/LC_MESSAGES/django.po b/src/open_inwoner/conf/locale/nl/LC_MESSAGES/django.po
@@ -3296,14 +3296,14 @@ msgstr ""
 #: open_inwoner/configurations/bootstrap/choices.py:10
 #, python-brace-format
 msgid ""
-"string represeting the (absolute) path to a file, including file extension: "
+"string representing the (absolute) path to a file, including file extension: "
 "{example}"
 msgstr ""
 
 #: open_inwoner/configurations/bootstrap/choices.py:15
 #, python-brace-format
 msgid ""
-"string represeting the (absolute) path to an image file, including file "
+"string representing the (absolute) path to an image file, including file "
 "extension: {example}"
 msgstr ""
 

diff --git a/src/open_inwoner/configurations/bootstrap/auth.py b/src/open_inwoner/configurations/bootstrap/auth.py
@@ -128,6 +128,7 @@ class eHerkenningOIDCConfigurationStep(BaseConfigurationStep):
         enable_setting="EHERKENNING_OIDC_CONFIG_ENABLE",
         namespace="EHERKENNING_OIDC",
         models=[OpenIDConnectEHerkenningConfig],
+        update_fields=True,
         required_settings=[
             "EHERKENNING_OIDC_OIDC_RP_CLIENT_ID",
             "EHERKENNING_OIDC_OIDC_RP_CLIENT_SECRET",
@@ -215,6 +216,7 @@ class AdminOIDCConfigurationStep(BaseConfigurationStep):
         display_name="Admin OIDC Configuration",
         namespace="ADMIN_OIDC",
         models=[OpenIDConnectConfig],
+        update_fields=True,
         required_settings=[
             "ADMIN_OIDC_OIDC_RP_CLIENT_ID",
             "ADMIN_OIDC_OIDC_RP_CLIENT_SECRET",
@@ -310,7 +312,7 @@ class DigiDSAMLConfigurationStep(BaseConfigurationStep):
         enable_setting="DIGID_SAML_CONFIG_ENABLE",
         namespace="DIGID_SAML",
         models=[DigidConfiguration],
-        update_field_descriptions=True,
+        update_fields=True,
         required_settings=[
             "DIGID_SAML_BASE_URL",
             "DIGID_SAML_CERTIFICATE_LABEL",
@@ -430,6 +432,7 @@ class eHerkenningSAMLConfigurationStep(BaseConfigurationStep):
         display_name="eHerkenning SAML Configuration",
         namespace="EHERKENNING_SAML",
         models=[EherkenningConfiguration],
+        update_fields=True,
         required_settings=[
             "EHERKENNING_SAML_CERTIFICATE_LABEL",
             "EHERKENNING_SAML_CERTIFICATE_TYPE",

diff --git a/src/open_inwoner/configurations/bootstrap/cms.py b/src/open_inwoner/configurations/bootstrap/cms.py
@@ -140,7 +140,7 @@ def __init__(
 class CMSBenefitsConfigurationStep(GenericCMSConfigurationStep):
     verbose_name = "Configuration for CMS social benefits (SSD) app"
     config_settings = CMSConfigSettings(
-        enable_setting="CMS_CONFIG_BENEFITS_ENABLE",
+        enable_setting="CMS_CONFIG_SSD_ENABLE",
         namespace="CMS_SSD",
         display_name="CMS apps configuration: Social Benefits",
     )
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,7 +13,7 @@ Enable/Disable configuration:

		::

		CMS_CASES_CONFIG_ENABLE
		CMS_CONFIG_CASES_ENABLE



Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,7 +13,7 @@ Enable/Disable configuration:

		::

		CMS_COLLABORATE_CONFIG_ENABLE
		CMS_CONFIG_COLLABORATE_ENABLE



Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,7 +13,7 @@ Enable/Disable configuration:

		::

		CMS_INBOX_CONFIG_ENABLE
		CMS_CONFIG_INBOX_ENABLE



Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,7 +13,7 @@ Enable/Disable configuration:

		::

		CMS_PRODUCTS_CONFIG_ENABLE
		CMS_CONFIG_PRODUCTS_ENABLE



Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,7 +13,7 @@ Enable/Disable configuration:

		::

		CMS_SSD_CONFIG_ENABLE
		CMS_CONFIG_SSD_ENABLE



Expand Down