Revise naming to provide a more user friendly naming structure (Newsletters => Mailing Lists; Newsletter issues => Announcements)

Created on 29 July 2022, over 2 years ago
Updated 2 September 2023, about 1 year ago

Problem/Motivation

Creating and managing mailing lists, subscribers and announcements is currently confusing, e.g., specific mailing lists and mailing list members are managed as "Newsletters" or "Simplenews", while individual announcements are managed as "Newsletter issues".

Proposed resolution

Revise naming to provide a more user friendly and consistent naming structure:

  • Rename "Newsletters" to "Mailing Lists"
  • Rename "Newsletter issues" to "Announcements".

Remaining tasks

Update module to follow a consistent naming, i.e., use of "Mailing Lists", and "Announcements" terms in module forms, help texts descriptions, URL paths, views, etc.

User interface changes

Menu item revisions

  • "Administer > Configuration > Web Services > Newsletters" to "Administer > Configuration > Web Services > Mailing Lists"
  • "Administer > Configuration > Web Services > Newsletters > ..." to "Administer > Configuration > Web Services > Mailing Lists > ..."
  • "Administer > Structure > Views > Newsletter issues" to "Administer > Structure > Views > Announcements"

UI elements (titles, labels, menu items, descriptions, etc.) in Forms, Views and etc.

  • Rename "Newsletters" to "Mailing Lists"
  • Rename "Newsletter issues" to "Announcements".

URL path revisions

  • "/admin/content/simplenews{/...}" to "/admin/content/announcements{/...}"
  • "/admin/people/simplenews{/...}" to "/admin/people/subscribers{/...}"
  • "/admin/config/services/simplenews{/...}" to "/admin/config/services/mailing-lists{/...}"
  • "/newsletter{/...}" to "/mailing-list{/...}"
  • "/user/{user}/simplenews" to "/user/{user}/mailing-lists"
  • "/node/{node}/simplenews" to "/node/{node}/mailing-list"

API changes

The same as URL path revisions.

Data model changes

Revise

  • simplenews.routing.yml
  • simplenews.links.task.yml
  • simplenews.links.menu.yml
  • simplenews.links.action.yml
✨ Feature request
Status

Needs work

Version

4.0

Component

User interface

Created by

πŸ‡ΈπŸ‡¦Saudi Arabia martins.bruvelis Thuwal

Live updates comments and jobs are added and updated live.
  • Usability

    Makes Drupal easier to use. Preferred over UX, D7UX, etc.

Sign in to follow issues

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • First commit to issue fork.
  • Status changed to Needs work over 1 year ago
  • πŸ‡¬πŸ‡§United Kingdom adamps

    What you say is somewhat true, although everyone will have different ideas on the best name. We could check what some of the mainstream mailing list providers do.

    • Rename "Newsletters" to "Mailing Lists": I would tend to agree
    • Rename "Newsletter issues" to "Announcements": I'm not sure, as it won't always be an announcement, it could be something quite different.

    However we have some problems to change things (and I expect the failing tests relate to these):

    1. If we change route names, config parameters etc it will break existing sites. At most what we can do is change the human readable UI text.
    2. If the external names don't match the internal ones (e.g. Newsletter.php defines an entity of type simplenews_newsletter), then that would also be confusing.
    3. People have got used to the current names, and some of them will be confused if things change.

    I'm not sure how much we can do here.

  • πŸ‡¬πŸ‡§United Kingdom adamps

    OK with the new 4.x branch we have a chance to make some non-BC changes.

    URLs should use the module name to avoid clashes, and in 5 out of 6 cases from the issue summary we do that already. I would support this change:
    "/newsletter{/...}" to "/simplenews{/...}"

  • Pipeline finished with Failed
    6 months ago
    Total: 465s
    #181252
Production build 0.71.5 2024