Skip to content

Commit 26055ce

Browse files
authored
feat: WI-71 remove/migrate settings_custom.py (#198)
* feat: WI-71 remove/migrate settings_custom.py * fix(epoc): WI-71 settings_custom migration delay Core-Portal-Deployments deploy setup for EPOC is in an unexpected state. J.G. said to skip it until he has time to update it, because "Its using the newest Camino branch with the oldest override possible." https://github.com/TACC/Core-Portal-Deployments/blob/f30609d/epoc/camino/docker-compose.pprd.override.yml#L25-L30 * chore(_readme_cms): delete (cuz repo deprecated) * docs: WI-71 settings_custom from Core-Portal-Deployments * docs: WI-71 fix cms.settings_custom reference * docs: WI-71 fix gitignore of settings is COre-CMS thing
1 parent bf8fbe4 commit 26055ce

File tree

17 files changed

+11
-736
lines changed

17 files changed

+11
-736
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ Within a `/custom_project_dir` can be:
5454
| - | - |
5555
| `static` | static assets, organized as Django CMS expects |
5656
| `templates` | templates and saved snippets |
57-
| `settings_custom.py` | project-specific values for [Core CMS] settings |
57+
| `settings_custom.py`[^3] | project-specific values for [Core CMS] settings |
58+
59+
[^3]: The `cms.settings_custom.py` is committed in [Core Portal Deployments]. A `settings_custom.py` in [Core CMS] is `.gitignore`'d.
5860

5961
## Prerequisites
6062

@@ -70,7 +72,7 @@ A CMS project is run within [Core CMS]. Also, [Git Submodules] must be pre-insta
7072

7173
Set up a new local CMS instance.
7274

73-
0. Set up Core CMS to run a local Core CMS Resources:
75+
0. Set up [Core CMS] to run a local [Core CMS Resources]:
7476

7577
1. If not already done:
7678
1. Clone [Core CMS] repository.
@@ -90,11 +92,7 @@ Set up a new local CMS instance.
9092
# This populates from this repository into `/taccsite_custom`.
9193
```
9294

93-
4. Create a symlink from `taccsite_cms/settings_custom.py` to `taccsite_custom/custom_project_dir/settings_custom.py`, e.g.
94-
95-
```sh
96-
ln -s '../taccsite_custom/custom_project_dir/settings_custom.py' 'taccsite_cms/settings_custom.py'
97-
```
95+
4. Create `/taccsite_cms/settings_custom.py`[^3] and populate it with respective `cms.settings_custom.py` from [Core Portal Deployments] e.g. [`/lccf/camino/cms.settings_custom.py`](https://github.com/TACC/Core-Portal-Deployments/blob/d8e31d9/lccf/camino/cms.settings_custom.py).
9896

9997
1. Enter the CMS Docker Container:
10098

@@ -136,7 +134,7 @@ Follow [Core CMS: Update Project](https://github.com/TACC/Core-CMS/blob/main/REA
136134

137135
## Develop Project
138136

139-
Follow "via Core CMS Resources" section of [Core CMS: Develop Custom Project](https://github.com/TACC/Core-CMS/blob/main/docs/develop-custom-project.md#via-core-cms-resources).
137+
Follow "via [Core CMS Resources]" section of [Core CMS: Develop Custom Project](https://github.com/TACC/Core-CMS/blob/main/docs/develop-custom-project.md#via-core-cms-resources).
140138

141139
## Debug Project
142140

@@ -159,6 +157,8 @@ To port a project to [Core CMS Custom], read [Port Project].
159157
[Core CMS]: https://github.com/TACC/Core-CMS
160158
[Core Portal]: https://github.com/TACC/Core-Portal
161159
[Core CMS Custom]: https://github.com/TACC/Core-CMS-Custom
160+
[Core CMS Resources]: https://github.com/TACC/Core-CMS-Resources
161+
[Core Portal Deployments]: https://github.com/TACC/Core-Portal-Deployments
162162

163163
[Git Submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
164164

_3dem_cms/settings_custom.py

-83
This file was deleted.

_readme_cms/README.md

-8
This file was deleted.

_readme_cms/__init__.py.md

-4
This file was deleted.

_readme_cms/_static/README.md

-21
This file was deleted.

_readme_cms/_static/_readme_cms/README.md

-9
This file was deleted.

_readme_cms/_templates/README.md

-32
This file was deleted.

_readme_cms/settings_custom.py.md

-9
This file was deleted.

brainmap_cms/settings_custom.py

-91
This file was deleted.

docs/run-multiple-projects.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,9 @@ To stop one project, and run another:
1818
make stop
1919
```
2020

21-
3. Replace existing symlink.
21+
3. Update custom settings.
2222

23-
Replace symlink `taccsite_cms/settings_custom.py` with one to `taccsite_custom/custom_project_dir/settings_custom.py`, e.g.
24-
25-
```sh
26-
rm -f 'taccsite_cms/settings_custom.py'
27-
ln -s '../taccsite_custom/custom_project_dir/settings_custom.py' 'taccsite_cms/settings_custom.py'
28-
```
23+
Update `taccsite_cms/settings_custom.py` with respective `cms.settings_custom.py` from [Core Portal Deployments] e.g. [`/lccf/camino/cms.settings_custom.py`](https://github.com/TACC/Core-Portal-Deployments/blob/d8e31d9/lccf/camino/cms.settings_custom.py).
2924

3025
4. Start the other project.
3126

@@ -53,3 +48,4 @@ To run multiple projects simultaneously:
5348
<!-- Link Aliases -->
5449

5550
[Core CMS]: https://github.com/TACC/Core-CMS
51+
[Core Portal Deployments]: https://github.com/TACC/Core-Portal-Deployments

example_cms/settings_custom.py

-57
This file was deleted.

0 commit comments

Comments
 (0)