Sulu Glossary Bundle Laravel Package

Product Decisions This Supports

• Build vs. buy for glossary/abbreviation management: This package replaces a custom editorial glossary feature with a maintained, first-party-style bundle. A PM can decide to adopt instead of building entity, workflow, admin UI, and cache invalidation from scratch — the surface area covered (draft/live per locale, versioning, trash, HTTP cache tagging, sitemap, smart content, SEO) is substantial and usually underestimated in a build estimate.
• Platform upgrade decisions: If the roadmap includes a Sulu 2 → Sulu 3 migration, this release is the successor to manuxi/sulu-abbreviations-bundle and ships dedicated migration commands (sulu:glossary:migrate-from-2x, sulu:glossary:migrate-page-references) plus a MySQL Doctrine migration template. This directly informs upgrade sequencing and deprecation of the old bundle.
• Editorial feature roadmap: The type field (abbreviation, acronym, term) plus the Twig abbr filter and sulu_resolve_glossary_entry support a real editorial glossary/terminology product, not just a static list. This supports decisions on content governance, accessibility (semantic <abbr> markup), and SEO (consistent terminology, structured links).
• Automation/publishing workflows: Optional sulu/automation-bundle integration brings scheduled publish/unpublish — relevant if the roadmap calls for time-boxed terminology campaigns, product launches, or compliance-driven content windows.
• Localization/translation investment: Draft/live per locale, "copy to locale," "delete translation," and "restore translation" make a case for multi-market content strategy decisions.
• CMS architecture decisions: Smart content, teaser, link, sitemap, preview, and route-default providers mean the glossary integrates as a first-class content type. This supports decisions about content reuse, reference integrity (refresher, resource loader), and search (SEAL reindexing across admin and website).
• Governance/operations: Configurable version retention (sulu_glossary.versioning.max_versions, default 20, 0 = unlimited) and domain events feeding the activity log support decisions on compliance and audit trail requirements.

When to Consider This Package

Consider adoption when:

• You are on Sulu 3 (this is a Sulu/Symfony bundle, not a framework-agnostic or Laravel-native package — confirm your stack before evaluating).
• You currently use or are migrating from manuxi/sulu-abbreviations-bundle 2.0 and need a supported successor.
• You need editorial glossaries, abbreviations, acronyms, or terminology management with draft/live, locale-specific content, and versioning.
• You require integrated content types, smart content, sitemap, teaser, and preview support rather than a standalone glossary.
• You need SEO and accessibility benefits (semantic abbr, cross-linking) with HTTP cache correctness.
• You need role-based access (sulu.glossary.entries, sulu.glossary.settings) and a full editorial workflow.
• You value a tested baseline: unit and functional tests, CI on PHP 8.2–8.4, PHPStan level 6, PHP CS Fixer, English and German docs.

Look elsewhere or defer when:

• You are still on Sulu 2 — v1.0.0 targets Sulu 3; wait or plan alongside the platform upgrade.
• Your stack is Laravel or another PHP framework — the bundle's dependencies (Sulu admin, Doctrine, SEAL, Symfony) are not portable.
• Your need is a one-off static glossary page; the bundle's workflow, providers, and migration tooling may be more than warranted.
• You depend on sulu/automation-bundle features you do not have installed — scheduled publishing is optional, so plan for that gap.
• You require a mature, long-tenured API surface — this is a first release, so expect iteration and budget for upgrade follow-through.

How to Pitch It (Stakeholders)

For executives: This is the first stable release of a glossary and terminology bundle for Sulu 3. It replaces an older community plugin with a maintained, tested package that gives editorial teams a full workflow for managing abbreviations, acronyms, and terms, localized per market, with built-in SEO, accessibility, and cache-safe publishing. It ships a migration path from the previous bundle, which lowers the risk and cost of the platform upgrade and avoids funding a bespoke feature build. Headline ask: approve adoption as the standard glossary capability and schedule the Sulu 3 migration around it.

For engineering: Adopt this instead of maintaining manuxi/sulu-abbreviations-bundle. It provides the entity model (UUID v7, draft/live per locale), the full workflow (publish, unpublish, remove draft, copy to locale, translation delete/restore, version restore), admin UI with security contexts, REST controllers, domain events for the activity log, content types and resource loader, and all the providers (smart content, teaser, link, sitemap, preview, route defaults). It handles SEAL reindexing for admin and website, HTTP cache tagging and invalidation, reference refreshing, and trash handling — the parts most custom builds get wrong. Migration commands and a Doctrine migration template are included; version retention is configurable. It is a 1.0.0, so pin the version, review the bundle's service and route configuration against our conventions, and budget time for the Sulu 3 upgrade and migration validation. Test coverage, PHPStan level 6, and CI on PHP 8.2–8.4 give a reasonable quality baseline.

For editorial and content leadership: You get a proper glossary workspace: entries with titles, explanations, descriptions, images, and links, typed as abbreviation, acronym, or term. Draft and live states per language, safe copy-to-locale, translation restore, and version history up to a configurable limit. Terminology can be surfaced automatically via the optional abbr filter, reused through smart content and teasers, and scheduled for publish/unpublish where automation is enabled.