Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Confusing naming of “versioned without staging” extension #387

Open
kinglozzer opened this issue Jan 10, 2023 · 0 comments
Open

Confusing naming of “versioned without staging” extension #387

kinglozzer opened this issue Jan 10, 2023 · 0 comments

Comments

@kinglozzer
Copy link
Member

Developers can apply versioning without staging (i.e. just version history, no draft/live) by applying the extension using the .versioned-suffixed service name, e.g.:

private static $extensions = [
    Versioned::class . '.versioned'
];

This naming doesn’t really explain what this variant of the extension does. The full versioning mode is suffixed .stagedversioned, which I suspect is where the .versioned suffix came from, but as the default alias for Versioned::class points to .stageversioned, no one ever uses or sees the suffix.

Suggest we adjust the non-staged suffix better explain what this mode is, possible alternatives:

  • Versioned::class . '.versioningonly'
  • Versioned::class . '.nostages'
  • Versioned::class . '.historyonly'

Naming things is always hard, open to suggestions 😄

We can keep the existing service name as an alias, either temporarily to make the CMS5 upgrade slightly easier or just keep it forever (it’s a single line in YAML)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant