chore: settings cleanup & match Core-CMS #273

wesleyboar · 2024-02-13T00:20:57Z

Overview / Changes

edited settings headers to match Core-CMS
deleted unused, default, and inappropriate settings
edited & moved comments
deleted _ prefix from BRANDING settings
moved settings

Testing

deploy to pre-prod servers any changes that deserve testing
_{(except demdata, because https://pprd.democratizing-site.tacc.utexas.edu/ was not setup for deploy at the time of this PR)}

UI

Skipped.

These settings can use Core's. Only enable what should be changed.

The original, fast solution was to hide it with CSS. Just setting BRANDING to False should have the same effect.

wesleyboar

Notes for reviewers.

wesleyboar · 2024-02-13T00:32:59Z

tapisproject_cms/src/taccsite_cms/settings_custom.py

-
-########################
-# TACC: GOOGLE ANALYTICS
-########################
-
-GOOGLE_ANALYTICS_PROPERTY_ID = "G-5EQ8Y25ZTM"


Why? Cuz this is already in (and belongs in) local CMS settings file on TACC/Core-Portal-Deployments.

wesleyboar · 2024-02-13T00:34:04Z

netsage_cms/src/taccsite_cms/settings_custom.py

-########################
-# DJANGO (EMAIL)
-########################
-
-# Set on server, NOT here
-# https://tacc-main.atlassian.net/wiki/x/ZhVv
-# EMAIL_BACKEND = "..."
-# EMAIL_HOST = "..."
-# DEFAULT_FROM_EMAIL = "..."


Why? Netsage does not send e-mail.

wesleyboar · 2024-02-13T00:34:33Z

netsage_cms/src/taccsite_cms/settings_custom.py

-########################
-# DJANGO CMS SETTINGS
-########################
-
-CMS_TEMPLATES = (
-    ('standard.html', 'Standard'),
-    ('fullwidth.html', 'Full Width'),
-
-    ('guide.html', 'Guide'),
-    ('guides/getting_started.tam.html', 'Guide: Getting Started'),
-    ('guides/data_transfer.html', 'Guide: Data Transfer'),
-    ('guides/data_transfer.globus.html', 'Guide: Globus Data Transfer'),
-    ('guides/portal_technology.html', 'Guide: Portal Technology Stack'),
-)


Why? Netsage does not use any templates beyond the defaults (it even uses less).

wesleyboar · 2024-02-13T00:38:05Z

example_cms/src/taccsite_cms/settings_custom.py

-CMS_TEMPLATES = (
-    ('standard.html', 'Standard'),
-    ('fullwidth.html', 'Full Width'),
-)
+# CMS_TEMPLATES = (
+#     ('standard.html', 'Standard'),
+#     ('fullwidth.html', 'Full Width'),
+
+#     ('guide.html', 'Guide'),
+#     ('guides/portal_technology.html', 'Guide: Portal Technology Stack'),
+# }


Why? In this example CMS, defaults are commented out to suggest you can change them. But defaults are not active, except for here. I am being consistent by commenting them out and showing the (current) defaults.

wesleyboar · 2024-02-13T00:39:10Z

ecep_cms/src/taccsite_cms/settings_custom.py

+########################
+# TACC: SEARCH
+########################
+
+# Support Google search instead of Portal's Elasticsearch
+SEARCH_PATH = '/site-search' # cuz Portal Nginx config hijacks /search
+SEARCH_QUERY_PARAM_NAME = 'q' # as Google expects


You added a feature in this PR?! Nope. I moved the settings up from further below, to match Core-CMS oorder.

wesleyboar · 2024-02-13T00:42:03Z

ecep_cms/src/taccsite_cms/settings_custom.py

-
-    ('guide.html', 'Guide'),
-    ('guides/getting_started.html', 'Guide: Getting Started'),
-    ('guides/data_transfer.html', 'Guide: Data Transfer'),
-    ('guides/data_transfer.globus.html', 'Guide: Globus Data Transfer'),
-    ('guides/portal_technology.html', 'Guide: Portal Technology Stack')


Why? Most are deprecated. The rest are default.

Why not just use default i.e. delete CMS_TEMPLATES here? Cuz ECEP site has skilled (but not expert) editors, that maybe could receive Page Template privilege but would be confused by options they should not use.

wesleyboar · 2024-02-13T00:43:08Z

demdata_cms/src/taccsite_cms/settings_custom.py

 ########################
-# TACC: PORTAL
-########################
-
-# Does this CMS site have a portal (default value: True)?
-INCLUDES_CORE_PORTAL = False
-INCLUDES_PORTAL_NAV = False
-INCLUDES_SEARCH_BAR = False


Woah, Pardner. Deleting these? Nope. Just moving them down further, to match Core-CMS order.

wesleyboar · 2024-02-13T00:46:02Z

demdata_cms/src/taccsite_cms/settings_custom.py

-TACC_BRANDING = [
-    "tacc",
-    "site_cms/img/org_logos/tacc-white.png",
-    "branding-tacc",
-    "https://www.tacc.utexas.edu/",
-    "_blank",
-    "TACC Logo",
-    "anonymous",
-    "True"
-]
-
-UTEXAS_BRANDING = [
-    "utexas",
-    "site_cms/img/org_logos/utaustin-white.png",
-    "branding-utaustin",
-    "https://www.utexas.edu/",
-    "_blank",
-    "University of Texas at Austin Logo",
-    "anonymous",
-    "True"
-]
-
-# NSF_BRANDING = [
-#     "nsf",
-#     "site_cms/img/org_logos/nsf-white.png",
-#     "branding-nsf",
-#     "https://www.nsf.gov/",
-#     "_blank",
-#     "NSF Logo",
-#     "anonymous",
-#     "True"
-# ]
-
-# BRANDING = [ TACC_BRANDING, UTEXAS_BRANDING, NSF_BRANDING ]
-BRANDING = [ TACC_BRANDING, UTEXAS_BRANDING ] # this matches prod 2022
-# BRANDING = [] # prod 2022 hides bar via snippet CSS but should also do this
+BRANDING = False


What?!

The active setting is BRANDING = [ TACC_BRANDING, UTEXAS_BRANDING ]... which is also the default. So delete it and all it's content/variables.

The BRANDING is not desired (hence CSS hides it on prod site), so just set BRANDING = False to prevent template from showing branding bar.

wesleyboar · 2024-02-13T15:52:06Z

This is an almost non-functional change. The possible issues would be obvious (logo, favicon, branding) and caught in pre-prod. Merging this so WI-110 is complete and WI-111 can begin.

After WI-111, then I am confident to delete settings in repositories.

wesleyboar added 11 commits February 12, 2024 15:55

style: consistent settings headers

0fa89ee

style: consistent settings headers (cont)

5b9acf3

style: settings headers & location match core

0345779

chore(ecep): no _ settings

00b54fc

chore(netsage): no _ nor unnecessary settings

1438c77

chore(tapis): no _ settings, add ldap setting

6f3ae29

chore(tapis): delete unused favicon

abdf848

chore(example): comment out CMS_TEMPLATES

a2799df

These settings can use Core's. Only enable what should be changed.

chore(ecep): remove unused templates

91a274f

chore(demdata): remove branding (css hides it)

b72403a

The original, fast solution was to hide it with CSS. Just setting BRANDING to False should have the same effect.

style(apcd): add missing newline at end of file

538c1c1

wesleyboar commented Feb 13, 2024

View reviewed changes

Merge branch 'main' into style/settings-clean-up-and-consistent-ify

f41e95c

wesleyboar requested a review from taoteg February 13, 2024 00:49

wesleyboar changed the title ~~chore: settings cleanup & match Core-CMS and Core-Portal-Deployments~~ chore: settings cleanup & match Core-CMS Feb 13, 2024

wesleyboar merged commit a2109be into main Feb 13, 2024

wesleyboar deleted the style/settings-clean-up-and-consistent-ify branch February 13, 2024 15:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: settings cleanup & match Core-CMS #273

chore: settings cleanup & match Core-CMS #273

wesleyboar commented Feb 13, 2024 •

edited

Loading

wesleyboar left a comment

wesleyboar Feb 13, 2024

wesleyboar Feb 13, 2024

wesleyboar Feb 13, 2024

wesleyboar Feb 13, 2024

wesleyboar Feb 13, 2024

wesleyboar Feb 13, 2024

wesleyboar Feb 13, 2024

wesleyboar Feb 13, 2024

wesleyboar commented Feb 13, 2024

chore: settings cleanup & match Core-CMS #273

chore: settings cleanup & match Core-CMS #273

Conversation

wesleyboar commented Feb 13, 2024 • edited Loading

Overview / Changes

Related

Testing

UI

wesleyboar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wesleyboar commented Feb 13, 2024

wesleyboar commented Feb 13, 2024 •

edited

Loading