Documentation for Commerce Inbox

Created on 22 July 2024, 5 months ago
Updated 19 August 2024, 4 months ago

Describe your bug or feature request.

The new commerce inbox seems like cool functionality, but it's not clear to me how it actually works. I also don't think I see anything about it in the docs at https://docs.drupalcommerce.org/.

I've seen in other issues that there seems to be a data feed of some sort that populates the inbox, but what sort of messages will appear there? Will other store-related messages show up there? Is there a way for us to inject our own messages into the inbox? How does message dismissal work? Etc.

As a developer, it might be nice to know about features from module updates in a feed. But I don't know whether I want the notices to appear to store admins since I don't know what will be appearing in there. Similarly, as a dev, I might care that "Commerce Core 2.27" does a thing, but showing versioning may be confusing to end-users.

From reading other issues, it seems like there may be a slight disconnect in that there are multiple target audience types for the inbox, but they are all being messaged in the same way.(i.e. site builders, devs, non-technical store owners, etc)

I'm running a marketplace on Commerce, so while the inbox seems useful, it feels like a blackbox with the potential for adverse effects on my platform's sellers. Having documentation would at least help to understand the implications of leaving it enabled, how to leverage it, and how to turn it off if needed.

✨ Feature request
Status

Fixed

Version

2.0

Component

Documentation

Created by

πŸ‡ΊπŸ‡ΈUnited States mrweiner

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @mrweiner
  • πŸ‡ΊπŸ‡ΈUnited States mrweiner

    Typo

  • Status changed to Fixed 5 months ago
  • πŸ‡ΊπŸ‡ΈUnited States rszrama

    I've added documentation to the user guide:

    https://docs.drupalcommerce.org/v2/user-guide/dashboard-inbox.md

    This includes a full listing of the various settings you can use to govern what does or doesn't appear throughout the Commerce backend from a dashboard / promotional standpoint. It scopes the messages a bit as in our blog post on the 2.37 release, though the real answer is, "We aren't using it much ... in fact, we haven't used it at all since launch." We'd like to, though, and we would definitely encourage any contributed module maintainer who adds or changes significant features to create messages via update hooks as in Commerce Core:

    https://git.drupalcode.org/project/commerce/-/blob/8.x-2.x/commerce.inst...

    If you're running a marketplace you'd likely need serious customization to make this useful ... e.g., ensuring that the store filter is applied to the current user's own store and the selector is hidden (or only shows stores they have access to manage). It's minimal by default, though, so you can either extend it (e.g., via hook_commerce_dashboard_page_build_alter()) or interact with it at will!

  • πŸ‡ΊπŸ‡ΈUnited States mrweiner

    Thank you!

  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024