docs: cleanup migration instructions (#185)

TACC · Aug 31, 2023 · b2595cf · b2595cf
1 parent 8d1723f
commit b2595cf
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 14 deletions.
diff --git a/docs/develop-project.md b/docs/develop-project.md
@@ -4,6 +4,8 @@ Read [Django CMS User Guide] for CMS user instructions.
 
 ## Table of Contents
 
+- [Create a New Project](#create-a-new-project)
+- [Create a New Build Action](#create-a-new-build-action)
 - [Remove Excess Content](#remove-excess-content)
 - [Customize Project](#customize-project)
 - [Create a Custom App](#create-a-custom-app)
@@ -15,7 +17,16 @@ Read [Django CMS User Guide] for CMS user instructions.
 2. Name the directory as WMA Infrastructure team defines e.g. `demdata_cms`.
 3. [Remove Excess Content](#remove-excess-content)
 4. [Customize Project](#customize-project)
-5. Perform instructions in other pertinent sections.
+5. [Create a New Build Action](#create-a-new-build-action)
+6. Perform instructions in other pertinent sections.
+
+## Create a New Build Action
+
+1. Clone [`.github/workflows/example-cms.yml`](../.github/workflows/example-cms.yml).
+2. Rename the file: replace `example` with the code name of the CMS to build.
+3. Edit the content: replace `example` with the code name of the CMS to build.
+4. Edit the content: replace `Example` with the human name of the CMS to build.
+5. Save this to the `main` branch. (You may be required to create a PR to do so.)
 
 ## Remove Excess Content
 
@@ -30,7 +41,9 @@ Read [Django CMS User Guide] for CMS user instructions.
 
 ## Customize Project
 
-Edit `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).
+Edit `./src/taccsite_cms/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).
 
 The settings usually edited are `LOGO` and `..._BRANDING`.
 

diff --git a/docs/port-project.md b/docs/port-project.md
@@ -22,14 +22,16 @@ 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`.
+1. 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`.
+2. From `/taccsite_custom/custom_project_dir/settings_custom.py`.\
     To `/custom_project_dir/src/taccsite_cms/settings_custom.py`.
 
-3. The name `custom_project_dir` **must** use underscores (**not** dashes),
-    because a valid Python application uses underscores.
+3. The name `custom_project_dir` **must** use underscores, **not** dashes.
+
+    > **Note**
+    > A valid Python application uses underscores.
 
 </details>
 
@@ -75,14 +77,14 @@ Then:
 
 1. Contact https://github.com/wesleyboar.
 
-> **Note**
-> Those imports assume:
->
-> - Node
-> - NPM package `@tacc/core-styles`
-> - a CSS build script
->
-> Whether to support those here, and how to port without support for those, has not been decided.
+    > **Note**
+    > Those `@import`s assume:
+    >
+    > - Node
+    > - NPM package `@tacc/core-styles`
+    > - a CSS build script
+    >
+    > Whether to support those here, and how to port without support for those, has not been decided.
 
 #### Expects CSS Concatenation
 

diff --git a/example_cms/src/__init__.py b/example_cms/src/__init__.py