Core-CMS-Custom

Custom assets for Core CMS projects

Tip

To customize a Core CMS project beyond assets, create a repository via Core CMS Template.

Caution

• If you change a file path, update Core Portal Deployments, because it reads this main branch.
• If you do not have access to Core Portal Deployments, then maybe do not change a file path.

Table of Contents

• Related Repositories
• Project Architecture
• Create Project
• Asset Management
• Build Project
• Deploy Project
• Port Project
• Upgrade Project

Related Repositories

• Camino, a Docker container-based deployment scheme
• Core CMS, the base CMS code for TACC WMA CMS Websites
• Core CMS Template, a template for creating new TACC WMA CMS projects
• Core Portal, the base Portal code for TACC WMA CMS Websites
• Core Styles, the shared UI pattern code for TACC WMA CMS Websites
• Core CMS Resources, the old solution for extensions of the Core CMS project
• Core Portal Deployments, private repository that facilitates deployments of Core Portal images via Camino and Jenkins

Project Architecture

Within a /customproject_assets can be:

directory	contents	notes
favicon.svg	current favicon	.svg preferred
favicon	other favicons
logo.svg	current logo	.svg preferred
logo	other logos
css	custom styles
js	custom scripts
snippets	reusable markup	manually saved

Create Project

1. Duplicate & Rename the example_assets directory.
2. Add your assets into that directory.
3. Get paths to those assets via a CDN.
4. Find the project in Core Portal Deployments.
5. Set those paths in its CMS settings file (example).

Asset Management

• Change Logo
• Custom Styles
• Save Snippets

Change Logo

Changes only header on both CMS pages and Portal interface.

1. Upload logo to folder (example).

2. In Core Portal Deployments,
   set path to that logo via CDN (example).

3. Deploy the change.

Custom Styles

These will load on every page.

1. Upload CSS to folder. Examples:

   • one short stylesheet
   • one long stylesheet
   • multiple stylesheets

2. In Core Portal Deployments,
   set path(s) to stylesheet(s) via CDN. Examples:

   • one stylesheet

   • multiple stylesheets

3. Deploy the change.

Save Snippets

Important

Snippets are not loaded by the CMS from here nor a CDN. They are maintained independently in the CMS admin interface. This folder just lets us version control them.

1. Upload snippet(s) to folder (example).

2. In the CMS admin interface:
   document the latest commit of each snippet (examples) e.g.

   • Name: Page: Members: JS (last commit: 2bcadc0)
   • Name: Page: Members: CSS (TACC/Core-CMS-Custom#321)

Build Project

Follow Core CMS: Build & Deploy Project.

Deploy Project

Follow "Deploy" section of How To Build & Deploy.

Port Project

To port a project from Core CMS Resources, read Port Project.

Upgrade Project

To upgrade the Core CMS of an existing project:

• Update its CMS image tag in Core Portal Deployments (example).