Theme Management and Naming Conventions for The Greatest Company

February 19, 2025

Theme Naming Conventions

To maintain organization and efficiency, the following naming convention must be used:

[Date] - [Current Work] - [STATUS]

  • [Date]:
    Use the theme's creation date in the format MM/DD/YY.
    Example: 12/04/24
  • [Current Work]:
    A concise description of the theme's purpose or work.
    Example: ADA Ready or Cyber Week Campaign.
  • [STATUS]:
    • LIVE: The active theme currently published.
    • STAGING - DO NOT EDIT: A clone of the LIVE Theme, used only as a backup.
    • TEMP: For temporary themes being used or tested, like marketing campaigns or experiments.
    • [CAMPAIGN NAME]: For specific campaigns, e.g., CYBER WEEK.

Examples of Theme Names:

  • 12/04/24 - ADA Ready - LIVE
  • STAGING - DO NOT EDIT
  • 12/04/24 - Cyber Week Campaign - TEMP

Rules for LIVE and STAGING Themes

  1. Always Have One LIVE Theme:
    • The LIVE Theme is the active, published theme visible to customers.
    • All updates or edits must be applied directly to the LIVE Theme.
    • After any implementation, test the website entirely and then clone the LIVE Theme to create the STAGING Theme.
  2. Always Have One STAGING Theme:
    • The STAGING Theme must always be an exact clone of the current LIVE Theme and labeled STAGING - DO NOT EDIT.
    • This theme acts as a backup and must never be edited directly.
    • If the LIVE Theme is updated, the current STAGING Theme must be deleted, and the updated LIVE Theme cloned to recreate the STAGING Theme.
  3. Campaign-Specific Themes:
    • Campaigns are created by cloning the LIVE Theme and labeling them with the campaign name (e.g., CYBER WEEK).
    • These campaign themes are edited and published independently of the STAGING Theme.

Process for STAGING Theme

  1. Clone the Current LIVE Theme:
    • After any implementation or updates, thoroughly test the website to ensure everything is working as expected.
  2. Create the STAGING Theme:
    • Clone the tested LIVE Theme and label it STAGING - DO NOT EDIT.
  3. Maintain STAGING Integrity:
    • The STAGING Theme must always reflect the current LIVE Theme and remain untouched until required as a fallback.

Seasonal Campaigns and Marketing Themes

  1. Creating Campaign Themes:
    • Clone the LIVE Theme and label it with the campaign name (e.g., CYBER WEEK - TEMP).
    • Make necessary edits and thoroughly test the campaign theme.
    • Once validated, publish the campaign theme as the new LIVE Theme.
  2. Campaign Workflow:
    • Step 1: Clone the LIVE Theme and label it with the current date and campaign name (e.g., 12/04/24 - Cyber Week - TEMP).
    • Step 2: Apply edits and thoroughly test.
    • Step 3: Publish the campaign theme as the new LIVE Theme.
    • Step 4: After the campaign ends, publish the previous LIVE Theme back to restore the original website.
    • Step 5: Delete unnecessary themes to maintain organization.

Examples for Campaign Management:

  • Before the campaign:
    • 12/04/24 - ADA Ready - LIVE
    • STAGING - DO NOT EDIT
    • 12/04/24 - Cyber Week - TEMP
  • After the campaign:
    • 12/04/24 - ADA Ready - LIVE
    • STAGING - DO NOT EDIT

Weekly Cleanups

To keep the theme section well-organized:

  1. Remove unused themes, such as old campaign or temporary themes.
  2. Ensure the following structure is maintained:
    • [Date] - ADA Ready - LIVE (Published)
    • STAGING - DO NOT EDIT
    • [Campaign Name] - TEMP (if a campaign is active)

Why Use This Naming Convention?

  1. Backup Safety: The STAGING - DO NOT EDIT Theme ensures a reliable fallback if updates to the LIVE Theme break the website.
  2. Efficiency: Temporary themes (TEMP) are clearly labeled and removed once their purpose is fulfilled, reducing clutter.
  3. Clarity: Campaign themes are clearly separated, making it easy to identify the purpose of each theme.
  4. Flexibility: Seasonal and marketing campaigns can be managed independently without interfering with the backup process.

By following these rules, the theme management process remains streamlined and fail-safe, even during high-traffic events.

Share this post