Skip to content

Commit 29c3bae

Browse files
authored
Merge branch 'main' into feat/script-to-setup-cms
2 parents 950facd + 311dd80 commit 29c3bae

9 files changed

Lines changed: 53 additions & 19 deletions

File tree

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
<!--
88
- [CMD-XYZ](https://tacc-main.atlassian.net/browse/CMD-XYZ)
9-
- requires https://github.com/TACC/Core-Styles/pull/5
10-
- required by https://github.com/TACC/Core-CMS-Resources/pull/117
9+
- requires https://github.com/TACC/Core-Styles/pull/123
10+
- required by https://github.com/TACC/Core-CMS-Custom/pull/123
1111
-->
1212

1313
## Changes

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The base CMS code for TACC WMA Workspace Portals & Websites
1313
- [Update Project](#update-project)
1414
- [Develop Project](#develop-project)
1515
- [Develop a Custom Project](#develop-a-custom-project)
16+
- [Develop a Custom App/Plugin](#develop-a-custom-appplugin)
1617
- [Debug Project](#debug-project)
1718
- [Build & Deploy Project](#build--deploy-project)
1819
- [Contributing](#contributing)
@@ -23,6 +24,7 @@ The base CMS code for TACC WMA Workspace Portals & Websites
2324
- [Camino], a Docker container-based deployment scheme
2425
- [Core Portal], the base Portal code for TACC WMA CMS Websites
2526
- [Core Styles], the shared UI pattern code for TACC WMA CMS Websites
27+
- [Core CMS Template], a template for creating new TACC WMA CMS projects
2628
- [Core CMS Resources], the old solution for extensions of the [Core CMS] project
2729
- [Core CMS Custom], the new solution for extensions of the [Core CMS] project
2830
- [Core Portal Deployments], private repository that facilitates deployments of [Core Portal] images via [Camino] and Jenkins
@@ -153,6 +155,10 @@ Read [Develop Project] for developer instructions.
153155

154156
To develop a new or existing custom CMS website for a client, read [Develop a Custom Project].
155157

158+
### Develop a Custom App/Plugin
159+
160+
To develop a new or existing Django CMS app or plugin for a client, read [Develop a Custom App/Plugin].
161+
156162
## Debug Project
157163

158164
Read [Debug Project] for miscellaneous tips.
@@ -182,6 +188,7 @@ To contribute, first read [How to Contirbute][Contributing].
182188
[Core CMS]: https://github.com/TACC/Core-CMS
183189
[Core Styles]: https://github.com/TACC/Core-Styles
184190
[Core CMS Resources]: https://github.com/TACC/Core-CMS-Resources
191+
[Core CMS Template]: https://github.com/TACC/Core-CMS-Template
185192
[Core CMS Custom]: https://github.com/TACC/Core-CMS-Custom
186193
[Core Portal]: https://github.com/TACC/Core-Portal
187194
[Core Portal Deployments]: https://github.com/TACC/Core-Portal-Deployments
@@ -195,6 +202,7 @@ To contribute, first read [How to Contirbute][Contributing].
195202
[Django CMS User Guide]: https://tacc-main.atlassian.net/wiki/x/phdv
196203

197204
[Develop a Custom Project]: ./docs/develop-custom-project.md
205+
[Develop a Custom App/Plugin]: ./docs/develop-custom-app.md
198206
[Develop Project]: ./docs/develop-project.md
199207
[Upgrade Project]: ./docs/upgrade-project.md
200208
[Debug Project]: ./docs/debug-project.md

docs/develop-custom-app.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Develop a Custom App
2+
3+
- [Create a **New** App](#create-a-new-app)
4+
- [**Extend** an Existing App](#extend-an-existing-app)
5+
6+
## Create a New App
7+
8+
Create a repository via the [TACC Django App].
9+
10+
_A sample repository created this way is [wesleyboar/Core-CMS-Plugin-Sample](https://github.com/wesleyboar/Core-CMS-Plugin-Sample)._
11+
12+
### Known Repos
13+
14+
- [search for such repos by TACC](https://github.com/search?q=org%3ATACC%20archived%3Afalse%20%22Core-CMS-Plugin%22&type=repositories)
15+
- [search for such repos by others](https://github.com/search?q=-org%3ATACC+-user%3Acementhorses+archived%3Afalse+%22Core-CMS-Plugin%22&type=repositories)
16+
17+
## Extend an Existing App
18+
19+
[Fork an existing app repository.](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
20+
21+
### Known Forks
22+
23+
- [search for Django CMS apps forked by TACC](https://github.com/search?q=fork%3Aonly+org%3ATACC+djangocms&type=repositories)
24+
25+
<!-- Link Aliases -->
26+
27+
[TACC Django App]: https://github.com/TACC/Django-App

docs/develop-custom-project.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,18 @@
22

33
| You can do these actions | via this resource | (status) |
44
| - | - | - |
5-
| **customize** templates, static assets, settings, custom apps, URLs, middleware | [Core-CMS-Custom](#via-core-cms-custom) | active |
6-
| **customize** templates, static assets, settings | [Core-CMS-Resources](#via-core-cms-resources) | deprecated |
7-
| **create** custom apps | [Django-App](https://github.com/TACC/Django-App) | active |
8-
| **create** forked apps e.g. [TACC/djangocms-forms](https://github.com/TACC/djangocms-forms) | ["Fork a repo"](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) | evergreen |
5+
| **customize** static assets | [Core CMS Custom] | active |
6+
| **customize** templates, static assets, settings | [Core CMS Resources](#via-core-cms-resources) | deprecated |
7+
| **customize** templates, static assets, custom apps, URLs, middleware | [Core CMS Template] | active |
8+
| **create** or **customize** an app | [Develop a Custom App/Plugin](./develop-custom-app.md) | active |
99

10-
## via [Core CMS Custom]
11-
12-
Work on the project **only** via [Core CMS Custom].
10+
## via [Core CMS Resources]
1311

14-
> **Note**
15-
> You should **not** need to clone **nor** edit this [Core CMS] repository.
12+
> [!DANGER]
13+
> Deprecated solution.
1614
17-
## via [Core CMS Resources]
15+
> [!TIP]
16+
> Use [Core CMS Custom] or [Core CMS Template] instead.
1817
1918
### Update Project
2019

@@ -70,8 +69,8 @@ To commit changes to a custom project:
7069

7170
[Core CMS]: https://github.com/TACC/Core-CMS
7271
[Core Styles]: https://github.com/TACC/Core-Styles
73-
[Core CMS Resources]: https://github.com/TACC/Core-CMS-Resources
7472
[Core CMS Custom]: https://github.com/TACC/Core-CMS-Custom
73+
[Core CMS Template]: https://github.com/TACC/Core-CMS-Template
7574

7675
[restart server]: https://github.com/TACC/Core-CMS/wiki/How-to-Restart-the-CMS-Server
7776
[collect static files]: ./develop-project.md#collect-static-files

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "tacc-core-cms-backend"
3-
version = "4.29.0"
3+
version = "4.29.1"
44
description = "DjangoCMS backend for the TACC ACI-WMA Core-CMS Codebase."
55
authors = ["TACC-WMA <wma-portals@tacc.utexas.edu>"]
66

taccsite_cms/settings_custom.example.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
]
5757

5858
# Generic TACC Portals.
59-
PORTAL_BRANDING = [ PORTAL_BRANDING_TACC, UTEXAS_BRANDING ]
59+
PORTAL_BRANDING = [ PORTAL_BRANDING_TACC, PORTAL_UTEXAS_BRANDING ]
6060

6161
# Custom-Branded Portals (Non-NSF).
6262
# PORTAL_BRANDING = [ PORTAL_BRANDING_TACC, PORTAL_BRANDING_UTEXAS, CUSTOM_BRANDING ]

taccsite_cms/static/site_cms/css/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ See [repo `README.md` at "Static Files"](/README.md#static-files).
1010

1111
- (Standard) Style TACC UI patterns in [Core Styles].
1212
- (Exception) Style CMS-specific UI in [Core CMS].
13-
- (Exception) Style project-specific UI in [Core CMS Resources].
13+
- (Exception) Style project-specific UI in [Core CMS Custom] or its own repo.
1414

1515

1616
<!-- Link Aliases -->
1717

1818
[Core CMS]: https://github.com/TACC/Core-CMS
19-
[Core CMS Resources]: https://github.com/TACC/Core-CMS-Resources
19+
[Core CMS Custom]: https://github.com/TACC/Core-CMS-Custom
2020
[Core Styles]: https://github.com/TACC/Core-Styles

taccsite_cms/templates/analytics.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
</script>
66
{% else %}
77
<!-- Global site tag (gtag.js) & Google Analytics Code for Site. -->
8-
<script async src="https://www.googletagmanager.com/gtag/js?id={{ settings.GOOGLE_ANALYTICS_PROPERTY_ID }}"></script>
8+
<script async nonce="CSP_NONCE" src="https://www.googletagmanager.com/gtag/js?id={{ settings.GOOGLE_ANALYTICS_PROPERTY_ID }}"></script>
99

1010
<!-- Analytics Code -->
1111
<script>

taccsite_custom

Submodule taccsite_custom updated 25 files

0 commit comments

Comments
 (0)