search

TACC / Core-CMS

The Core CMS codebase used by TACC Portals.
https://cep.tacc.utexas.edu
2 stars 1 forks source link

refactor: cmd-79 rename tacc cms settings #792

Closed wesleyboar closed 1 month ago

wesleyboar commented 6 months ago

Overview

Reword TACC_ settings as PORTAL_ settings.

Because (A) Core-CMS is used by clients, so "TACC_LOGO" is a weird setting (because they have their own logo) and (B) The CMS and Portal are aspects of a website that is called Portal in TACC-speak (and I am done grumbling against it).

Status

Related

Changes

Testing & UI

https://github.com/TACC/Core-Portal-Deployments/pull/43

taoteg commented 3 months ago

PORTAL_MANAGES_AUTH works for me, it has the PORTAL_ prefix and explicitly states what it does. PORTAL_IS_CORE feels too ambiguous imo. Question: What property/aspect of a portal configuration is this supposed to be indicating if not that the AUTH source is the django container?

Aside: I do so which we had called Core-Portal something less overloaded (Core-Workbench, Core-Dashboard, Core-Django, Core-Workspace, literally anything else that would not conflate the use of portal), but it is what it is now...

wesleyboar commented 1 month ago

I changed PORTAL_IS_CORE to PORTAL_IS_TACC_CORE_PORTAL.

Goal is clarity and accuracy. I see the setting is **not** _solely_ used to describe Core-Portal managing auth. It also describes code that Core-Portal expects but is not necessary for all portals (e.g. TUP, or a future one with a better way to share header) nor related to auth.

Perhaps we revisit PORTAL_MANAGES_AUTH as a setting if we make CMS support LDAP.

wesleyboar commented 1 month ago

I tested this on every [Camino-deployed] Core-CMS website —

— and the only bug was because of upgrading ECEP to v4.9+.

[!IMPORTANT] Merging based on approval of https://github.com/TACC/Core-Portal-Deployments/pull/43.