feat!: rename directories, "-" → "_" (for django 3) (#176)

README.md

@@ -4,16 +4,19 @@ The project-specific CMS code for TACC WMA Workspace Websites.
 
 To add resources for a new project:
 
-1. Clone `/example-cms`.
-2. Read `/_readme-cms`.
+1. Clone `/example_cms`.
+2. Read `/_readme_cms`.
 
 To build such a CMS project, use [TACC/Core-CMS](https://github.com/TACC/Core-CMS).
 
+> **Warning**
+> Do **not** deploy these websites via this repository with [TACC/Core-CMS#v3.12.0](https://github.com/TACC/Core-CMS/releases/tag/v3.12.0) or greater. **Instead**, migrate them to [Core CMS Custom].[^1]
 
 ## Related Repositories
 
 - [Camino], a Docker container-based deployment scheme
 - [Core CMS], the base CMS code for TACC WMA CMS Websites
+- [Core CMS Custom], the custom CMS code (new solution) for TACC WMA CMS Websites
 
 
 ## Intended Usage
@@ -27,19 +30,23 @@ Please see the [Core CMS README].
 
 ## Websites Maintained
 
-- https://prod.a2cps.tacc.utexas.edu/
+- https://prod.a2cps.tacc.utexas.edu/ a.k.a. https://a2cps.org/<br />
+  <sup>code has moved to https://github.com/TACC/Core-CMS-Custom/blob/main/a2cps_cms/</sup>
 - https://prod.apcd.tacc.utexas.edu/ a.k.a. https://txapcd.org/<br />
-  <sup>code has moved to https://github.com/TACC/Core-CMS-Custom/blob/main/apcd-cms/</sup>
+  <sup>code has moved to https://github.com/TACC/Core-CMS-Custom/blob/main/apcd_cms/</sup>
 - https://portal.brainmap.org/
-- https://democratizingdata.ai/
-- https://prod.ecep.tacc.utexas.edu/ a.k.a. https://ecepalliance.org/
+- https://democratizingdata.ai/<br />
+  <sup>code has moved to https://github.com/TACC/Core-CMS-Custom/blob/main/apcd_cms/</sup>
+- https://prod.ecep.tacc.utexas.edu/ a.k.a. https://ecepalliance.org/<br />
+  <sup>code has moved to https://github.com/TACC/Core-CMS-Custom/blob/main/ecep_cms/</sup>
 - https://prod.epoc.tacc.utexas.edu/
 - https://frontera-portal.tacc.utexas.edu/
 - https://lccf.tacc.utexas.edu/
 - https://3dem.org/
 - https://prod.protx.tacc.utexas.edu/
 - https://prod.sciviscolor.tacc.utexas.edu/
-- https://tapis-project.org/
+- https://tapis-project.org/<br />
+  <sup>code has moved to https://github.com/TACC/Core-CMS-Custom/blob/main/tapisproject_cms/</sup>
 - https://texascale.org/
 - https://dev.tup.tacc.utexas.edu/<br />
   <sup>code has moved to https://github.com/TACC/tup-ui/blob/main/apps/tup-cms/</sup>
@@ -49,5 +56,8 @@ Please see the [Core CMS README].
 
 [Core CMS]: https://github.com/TACC/Core-CMS
 [Core Styles]: https://github.com/TACC/Core-Styles
+[Core CMS Custom]: https://github.com/TACC/Core-CMS-Custom
 [Core CMS README]: https://github.com/TACC/Core-CMS/blob/main/README.md
 [Camino]: https://github.com/TACC/Camino
+
+[^1]: [Websites with custom templates will experience a major problem.](https://github.com/TACC/Core-CMS-Resources/pull/176#issuecomment-1603194690) Even though not all websites have such templates **and** there is a [tested solution](https://github.com/TACC/Core-CMS-Resources/pull/176#issuecomment-1603215969), website development benefits so much from migration, that every opportunity is taken to encourage it.

_readme-cms/_static/README.md → _readme_cms/_static/README.md

@@ -9,9 +9,9 @@ Otherwise, they will be unavailable to [Core CMS] loading this project.
 
 ## Directory Hierarchy
 
-Where `name-of-project` is a CMS projects with custom static assets:
+Where `name_of_project` is a CMS projects with custom static assets:
 
-- `/name-of-project/static/name-of-project/...`
+- `/name_of_project/static/name_of_project/...`
 
 The redundancy is intentional:
 

_readme-cms/_templates/README.md → _readme_cms/_templates/README.md

@@ -13,9 +13,9 @@ This consistency lets us override templates in Django fashion.
 
 ## How to Write Template Path
 
-Where `name-of-project` is a CMS projects with custom templates:
+Where `name_of_project` is a CMS projects with custom templates:
 
-- `/name-of-project/templates/___.html`
+- `/name_of_project/templates/___.html`
 
 ### How to Overwrite Core Templates
 

a2cps-cms/settings_custom.py → a2cps_cms/settings_custom.py

@@ -8,8 +8,8 @@
 ########################
 
 CMS_TEMPLATES = (
-    ('a2cps-cms/templates/standard.html', 'Standard'),
-    ('a2cps-cms/templates/fullwidth.html', 'Full Width'),
+    ('a2cps_cms/templates/standard.html', 'Standard'),
+    ('a2cps_cms/templates/fullwidth.html', 'Full Width'),
     ('guide.html', 'Guide'),
     ('guides/getting_started.html', 'Guide: Getting Started'),
     ('guides/data_transfer.html', 'Guide: Data Transfer'),
@@ -23,7 +23,7 @@
 
 LOGO = [
     "a2cps",
-    "a2cps-cms/img/org_logos/a2cps.png",
+    "a2cps_cms/img/org_logos/a2cps.png",
     "",
     "/",
     "_self",
@@ -33,5 +33,5 @@
 ]
 
 FAVICON = {
-    "img_file_src": "a2cps-cms/img/org_logos/favicon.ico"
+    "img_file_src": "a2cps_cms/img/org_logos/favicon.ico"
 }

a2cps-cms/templates/assets_custom.html → a2cps_cms/templates/assets_custom.html

@@ -1,4 +1,4 @@
 {% load static %}
 
 <!-- To style old CMS content on new CMS -->
-<link rel="stylesheet" href="{% static 'a2cps-cms/css/build/migrate.v1_v2.css' %}">
+<link rel="stylesheet" href="{% static 'a2cps_cms/css/build/migrate.v1_v2.css' %}">

brainmap-cms/settings_custom.py → brainmap_cms/settings_custom.py

@@ -25,7 +25,7 @@
 
 _UTHSCSA_BRANDING = [
     "uthscsa",
-    "brainmap-cms/img/org_logos/uthscsa-logo-white.png",
+    "brainmap_cms/img/org_logos/uthscsa-logo-white.png",
     "branding-logo--short",
     "https://www.uthscsa.edu/",
     "_blank",
@@ -36,7 +36,7 @@
 
 _SGCI_BRANDING = [
     "sgci",
-    "brainmap-cms/img/org_logos/sgci-logo-sans-text.svg",
+    "brainmap_cms/img/org_logos/sgci-logo-sans-text.svg",
     "branding-logo--short",
     "https://sciencegateways.org/",
     "_blank",
@@ -75,7 +75,7 @@
 
 LOGO = [
     "brainmap",
-    "brainmap-cms/img/org_logos/brainmap-logo--light-text-trans-bkgd--large-text.svg",
+    "brainmap_cms/img/org_logos/brainmap-logo--light-text-trans-bkgd--large-text.svg",
     "",
     "/",
     "_self",
@@ -85,5 +85,5 @@
 ]
 
 FAVICON = {
-    "img_file_src": "brainmap-cms/img/org_logos/brainmap-logo--dark-text-trans-bkgd--icon-only.png"
+    "img_file_src": "brainmap_cms/img/org_logos/brainmap-logo--dark-text-trans-bkgd--icon-only.png"
 }

brainmap-cms/templates/snippets/site-css.html → brainmap_cms/templates/snippets/site-css.html

@@ -1,4 +1,4 @@
 {% load staticfiles %}
 
 {# TODO: FP-1652: Move to template that extends core_cms one #}
-<link rel="stylesheet" href="{% static 'brainmap-cms/css/build/site.css' %}">
+<link rel="stylesheet" href="{% static 'brainmap_cms/css/build/site.css' %}">

ecep-cms/settings_custom.py → ecep_cms/settings_custom.py

@@ -65,7 +65,7 @@
 
 LOGO = [
     "ecep",
-    "ecep-cms/img/org_logos/ecep-white-no_words.svg",
+    "ecep_cms/img/org_logos/ecep-white-no_words.svg",
     "",
     "/",
     "_self",
@@ -75,7 +75,7 @@
 ]
 
 FAVICON = {
-    "img_file_src": "ecep-cms/img/org_logos/favicon.ico"
+    "img_file_src": "ecep_cms/img/org_logos/favicon.ico"
 }
 
 ########################
@@ -143,4 +143,4 @@
 # CLIENT BUILD SETTINGS
 ########################
 
-ROOT_URLCONF = 'taccsite_custom.ecep-cms.urls'
+ROOT_URLCONF = 'taccsite_custom.ecep_cms.urls'

ecep-cms/templates/snippets/site-css.html → ecep_cms/templates/snippets/site-css.html

@@ -1,4 +1,4 @@
-{% load staticfiles %}
+{% load static %}
 
 {# TODO: FP-1487: Move this to a templates/*.html that extends a site_cms one #}
-<link rel="stylesheet" href="{% static 'ecep-cms/css/build/site.css' %}">
+<link rel="stylesheet" href="{% static 'ecep_cms/css/build/site.css' %}">

epoc-cms/settings_custom.py → epoc_cms/settings_custom.py

@@ -23,9 +23,9 @@
 # WALKTHROUGH
 ########################
 
-# To change LDAP auth settings for a custom CMS Project (e.g. `epoc-cms`):
+# To change LDAP auth settings for a custom CMS Project (e.g. `epoc_cms`):
 # 1. Copy the setting from `settings.py`
-# 2. Assign the new value in `Core-CMS/taccsite_custom/epoc-cms/settings_custom.py`.
+# 2. Assign the new value in `Core-CMS/taccsite_custom/epoc_cms/settings_custom.py`.
 AUTH_LDAP_SERVER_URI = "ldap://cluster.ldap.tacc.utexas.edu"
 
 # The same goes for other more commonly customized values like below.
@@ -68,7 +68,7 @@
 
 TACC_BRANDING = [
     "tacc",
-    "epoc-cms/img/org_logos/tacc-white.png",
+    "epoc_cms/img/org_logos/tacc-white.png",
     "branding-tacc",
     "https://www.tacc.utexas.edu/",
     "_blank",
@@ -79,7 +79,7 @@
 
 UTEXAS_BRANDING = [
     "utexas",
-    "epoc-cms/img/org_logos/utaustin-white.png",
+    "epoc_cms/img/org_logos/utaustin-white.png",
     "branding-utaustin",
     "https://www.utexas.edu/",
     "_blank",
@@ -90,7 +90,7 @@
 
 NSF_BRANDING = [
     "nsf",
-    "epoc-cms/img/org_logos/nsf-white.png",
+    "epoc_cms/img/org_logos/nsf-white.png",
     "branding-nsf",
     "https://www.nsf.gov/",
     "_blank",
@@ -101,7 +101,7 @@
 
 CUSTOM_BRANDING = [
     "epoc",
-    "epoc-cms/img/org_logos/esnet-white-logo.png",
+    "epoc_cms/img/org_logos/esnet-white-logo.png",
     "branding-logo--short",
     "https://www.es.net/",
     "_blank",
@@ -118,7 +118,7 @@
 
 LOGO =  [
     "epoc",
-    "epoc-cms/img/org_logos/epoc-color-logo.png",
+    "epoc_cms/img/org_logos/epoc-color-logo.png",
     "",
     "/",
     "_self",
@@ -128,5 +128,5 @@
 ]
 
 FAVICON = {
-    "img_file_src": "epoc-cms/img/org_logos/favicon.ico"
+    "img_file_src": "epoc_cms/img/org_logos/favicon.ico"
 }

example-cms/settings_custom.py → example_cms/settings_custom.py

@@ -30,7 +30,7 @@
 #
 # _CUSTOM_BRANDING = [
 #     "example",
-#     "example-cms/img/org_logos/example-logo.png",
+#     "example_cms/img/org_logos/example-logo.png",
 #     "",
 #     "https://example.com",
 #     "_blank",
@@ -47,7 +47,7 @@
 
 LOGO =  [
     "example",
-    "example-cms/img/org_logos/portal.png",
+    "example_cms/img/org_logos/portal.png",
     "",
     "/",
     "_self",

frontera-cms/settings_custom.py → frontera_cms/settings_custom.py

@@ -10,9 +10,9 @@
 ########################
 
 CMS_TEMPLATES = (
-    ('frontera-cms/templates/standard.html', 'Standard'),
-    ('frontera-cms/templates/fullwidth.html', 'Full Width'),
-    ('frontera-cms/templates/home.html', 'Homepage'),
+    ('frontera_cms/templates/standard.html', 'Standard'),
+    ('frontera_cms/templates/fullwidth.html', 'Full Width'),
+    ('frontera_cms/templates/home.html', 'Homepage'),
 
     ('guide.html', 'Guide'),
     ('guides/getting_started.html', 'Guide: Getting Started'),
@@ -38,7 +38,7 @@
 
 _FRONTERA_TACC_BRANDING = [
     "tacc",
-    "frontera-cms/img/org_logos/tacc-white.png", # TACC/Core-CMS#283 & #284
+    "frontera_cms/img/org_logos/tacc-white.png", # TACC/Core-CMS#283 & #284
     "branding-tacc",
     "https://www.tacc.utexas.edu/",
     "_blank",
@@ -66,7 +66,7 @@
 
 LOGO =  [
     "frontera",
-    "frontera-cms/img/org_logos/frontera-white-solo.png",
+    "frontera_cms/img/org_logos/frontera-white-solo.png",
     "",
     "/",
     "_self",
@@ -76,5 +76,5 @@
 ]
 
 FAVICON = {
-    "img_file_src": "frontera-cms/img/org_logos/favicon.ico"
+    "img_file_src": "frontera_cms/img/org_logos/favicon.ico"
 }

frontera-cms/static/frontera-cms/css/src/_migrations/v1_v2/frontera.css → frontera_cms/static/frontera_cms/css/src/_migrations/v1_v2/frontera.css

@@ -12,28 +12,28 @@ SRC: https://bitbucket.org/taccaci/frontera/src/master/client/css/frontera.scss
 /* FAQ: Though CMS default font is `Benton Sans`, old content uses these */
 @font-face {
     font-family: BentonSansBold;
-    src: url("/static/frontera-cms/fonts/archive/BentonSans-Bold.otf");
+    src: url("/static/frontera_cms/fonts/archive/BentonSans-Bold.otf");
 }
 
 @font-face {
     font-family: BentonSansMedium;
-    src: url("/static/frontera-cms/fonts/archive/BentonSans-Medium.otf");
+    src: url("/static/frontera_cms/fonts/archive/BentonSans-Medium.otf");
 }
 
 @font-face {
     font-family: BentonSansItalic;
-    src: url("/static/frontera-cms/fonts/archive/BentonSans-MediumItalic.otf");
+    src: url("/static/frontera_cms/fonts/archive/BentonSans-MediumItalic.otf");
 }
 
 /* … */
 
 /* HELP: Wesley assumes that old content uses these… but where? */
 @font-face {
 	font-family: 'icon-worksregular';
-	src: url('/static/frontera-cms/fonts/archive/icon-works-webfont.eot');
-	src: url('/static/frontera-cms/fonts/archive/icon-works-webfont.eot?#iefix') format('embedded-opentype'),
-		url('/static/frontera-cms/fonts/archive/icon-works-webfont.woff') format('woff'),
-		url('/static/frontera-cms/fonts/archive/icon-works-webfont.svg#icon-worksregular') format('svg');
+	src: url('/static/frontera_cms/fonts/archive/icon-works-webfont.eot');
+	src: url('/static/frontera_cms/fonts/archive/icon-works-webfont.eot?#iefix') format('embedded-opentype'),
+		url('/static/frontera_cms/fonts/archive/icon-works-webfont.woff') format('woff'),
+		url('/static/frontera_cms/fonts/archive/icon-works-webfont.svg#icon-worksregular') format('svg');
 	font-weight: normal;
 	font-style: normal;
 }

frontera_cms/templates/assets_custom.html

@@ -0,0 +1,3 @@
+{% load static %}
+
+<link rel="stylesheet" href="{% static 'frontera_cms/css/build/site.css' %}">

frontera-cms/templates/fullwidth.html → frontera_cms/templates/fullwidth.html

@@ -11,5 +11,5 @@
              - Frontera was tested with this load order (so let it lie)
              - Frontera is being redesigned (which will obviate this stylesheet)
   -->
-  <link rel="stylesheet" href="{% static 'frontera-cms/css/build/migrate.v1_v2.css' %}">
+  <link rel="stylesheet" href="{% static 'frontera_cms/css/build/migrate.v1_v2.css' %}">
 {% endblock assets_custom %}

frontera-cms/templates/home.html → frontera_cms/templates/home.html

@@ -13,7 +13,7 @@
   html { font-size: 62.5%; /* 1rem = 10px */ }
   </style>
 
-  <link rel="stylesheet" href="{% static 'frontera-cms/css/build/template.home.css' %}">
+  <link rel="stylesheet" href="{% static 'frontera_cms/css/build/template.home.css' %}">
 {% endblock assets_custom %}
 
 {# FAQ: Common practice but unused, and template is unnecessary long-term #}

neuronex-cms/settings_custom.py → neuronex_cms/settings_custom.py

@@ -10,7 +10,7 @@
 ########################
 
 CMS_TEMPLATES = (
-    ('neuronex-cms/templates/fullwidth.html', 'Fullwidth'),
+    ('neuronex_cms/templates/fullwidth.html', 'Fullwidth'),
     ('home_portal.html', 'Standard Portal Homepage'),
     ('guide.html', 'Guide'),
     ('guides/getting_started.html', 'Guide: Getting Started'),
@@ -64,7 +64,7 @@
 
 LOGO = [
     "portal",
-    "neuronex-cms/img/org_logos/logo.3dem.png",
+    "neuronex_cms/img/org_logos/logo.3dem.png",
     "",
     "/",
     "_self",
@@ -74,5 +74,5 @@
 ]
 
 FAVICON = {
-    "img_file_src": "neuronex-cms/img/org_logos/favicon.ico"
+    "img_file_src": "neuronex_cms/img/org_logos/favicon.ico"
 }