feat: WI-71 remove/migrate settings_custom.py (#278)

* feat: WI-71 remove/migrate settings_custom.py

* feat: WI-71 restore empty taccsite_cms dirs

* docs(netsage): fix inaccurate CMS tag comment

* feat(ptdatax): remove build workflow

no need, it just houses assets

* docs: WI-71 settings_custom from Core-Portal-Deployments

* ci: WI-71 ignore settings_custom

.gitignore

@@ -5,8 +5,9 @@
 .DS_Store
 
 # ignore secrets & settings
+## so dev learns those should not be committed in this repo
 *secrets.py
-*settings_secret.py
+*settings_custom.py
 *settings_local.py
 
 # no node modules

a2cps_cms/src/taccsite_cms/README.md

@@ -0,0 +1,3 @@
+# `taccsite_cms/`
+
+Add files to overwrite those in this directory within [Core-CMS](https://github.com/TACC/Core-CMS).

demdata_cms/src/taccsite_cms/README.md

@@ -0,0 +1,3 @@
+# `taccsite_cms/`
+
+Add files to overwrite those in this directory within [Core-CMS](https://github.com/TACC/Core-CMS).

docs/develop-project.md

@@ -41,9 +41,12 @@ Read [Django CMS User Guide] for CMS user instructions.
 
 ## Customize Project
 
-Edit `./src/taccsite_cms/settings_custom.py`.
+| Purpose | File to Update |
+| - | - |
+| Test | `/custom_project_dir/src/taccsite_cms/settings_custom.py` |
+| Commit | [TACC/Core-Portal-Deployments][Core Portal Deployments]:`/project_dir/camino/settings_custom.py` |
 
-To know what settings are available, see [Core-CMS `settings.py`](https://github.com/TACC/Core-CMS/blob/main/taccsite_cms/settings.py).
+To know what settings are available, see [TACC/Core-CMS:`/taccsite_cms/settings.py`](https://github.com/TACC/Core-CMS/blob/main/taccsite_cms/settings.py).
 
 The settings usually edited are `LOGO` and `..._BRANDING`.
 
@@ -72,6 +75,7 @@ If there is a change that should be made in all CMS projects, consider whether i
 [Core CMS]: https://github.com/TACC/Core-CMS
 [Core Portal]: https://github.com/TACC/Core-Portal
 [Core Styles]: https://github.com/TACC/Core-Styles
+[Core Portal Deployments]: https://github.com/TACC/Core-Portal-Deployments
 
 [TACC UI Patterns]: https://tacc.utexas.edu/static/ui/
 

docs/port-project.md

@@ -26,19 +26,27 @@ Follow steps in [Create a New Project](./develop-project.md#create-a-new-project
 
 <details><summary>Reminders</summary>
 
-1. From [Core CMS Resources] `/taccsite_custom/custom_project_dir`.\
-    To `/custom_project_dir/src/taccsite_custom/custom_project_dir`.
+1. | Move | Content |
+    | - | - |
+    | From | [Core CMS Resources] `/taccsite_custom/custom_project_dir`. |
+    | To | `/custom_project_dir/src/taccsite_custom/custom_project_dir` |
 
-2. From `/taccsite_custom/custom_project_dir/settings_custom.py`.\
-    To `/custom_project_dir/src/taccsite_cms/settings_custom.py`.
+2. | Copy | Settings |
+    | - | - |
+    | From | [TACC/Core-Portal-Deployments][Core Portal Deployments]:`/project_dir/camino/settings_custom.py`. |
+    | To | `/custom_project_dir/src/taccsite_cms/settings_custom.py`.[^1] |
 
-3. The name `custom_project_dir` **must** use underscores, **not** dashes.
+3. | Use | Not |
+    | - | - |
+    | `custom_project_dir` | `custom-project-dir` |
 
     > **Important**
     > A valid Python application uses underscores.
 
 </details>
 
+[^1]: The `cms.settings_custom.py` is committed in [Core Portal Deployments]. A `settings_custom.py` in [Core CMS Custom] is `.gitignore`'d.
+
 ### Migrate Project to [Core CMS] v3.12
 
 Follow [Core CMS: Upgrade Project: from v3.N to v3.12](https://github.com/TACC/Core-CMS/blob/main/docs/upgrade-project.md#from-v3n-to-v312).
@@ -55,9 +63,13 @@ Follow [Core CMS: Upgrade Project: from v3.N to v3.12](https://github.com/TACC/C
 Then:
 
 1. You must edit [Core Portal Deployments].
-2. Edit `custom_project_dir/camino/___.settings_custom.py` (not `___.cms.…`).
-3. Change `_PORTAL_ICON_FILENAME` to:\
-    `/static/` + ( the `img_file_src` of `FAVICON` )
+2. Edit Portal settings for the appropriate server.\
+    <sup>E.g. `project_dir/camino/___.settings_custom.py` where `___` is `dev`, `pprd`, `prod` as appropriate (**not** `cms`).</sup>
+3. Update `_PORTAL_ICON_FILENAME`:
+    | if `is_remote` is | then set value to |
+    | - | - |
+    | `False` | `/static/` **+** the `img_file_src` of `FAVICON` |
+    | `True` | the `img_file_src` of `FAVICON` |
 
 #### Expects CSS Build Step
 

docs/upgrade-project.md

@@ -83,9 +83,13 @@ Simplify image paths.
     | to | `taccsite_custom/static/custom_project_dir/img/...` |
 
 2. Rename **all** references to the previous image paths e.g.
-    - in `settings_custom.py`
+    - `/custom_project_dir/taccsite_cms/settings_custom.py` [^1]
+    - [Core Portal Deployments]:`/project_dir/camino/cms.settings_custom.py` [^1]
 
+[^1]: The `cms.settings_custom.py` is committed in [Core Portal Deployments]. A `settings_custom.py` in [Core CMS Custom] is `.gitignore`'d.
 
 <!-- Link Aliases -->
 
 [Core CMS]: https://github.com/TACC/Core-CMS
+[Core CMS Custom]: https://github.com/TACC/Core-CMS-Custom
+[Core Portal Deployments]: https://github.com/TACC/Core-Portal-Deployments