Skip to content

Update Magento_AdminNotification module ReadMe #24129

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 15, 2019
Merged

Update Magento_AdminNotification module ReadMe #24129

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7173a6
Update Admin Notification ReadMe
diazwatson Aug 14, 2019
1dad97c
Update Admin Notification ReadMe
diazwatson Aug 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions app/code/Magento/AdminNotification/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,29 @@
# Admin Notification
# Magento_AdminNotification module

**Admin Notification** provides the ability to alert administrators via
system messages and provides a message inbox for surveys and notifications.
The Magento_AdminNotification module provides the ability to alert administrators via system messages and provides a message inbox for surveys and notifications.

## Installation details

Before disable or uninstall this module, please note that Magento_Indexer module depends on this module.

For information about a module installation in Magento 2, see [Enable or disable modules](http://devdocs.magento.com/guides/v2.3/install-gde/install/cli/install-cli-subcommands-enable.html).

### Events

This module observes the following events:

- `controller_action_predispatch` event in `Magento\AdminNotification\Observer\PredispatchAdminActionControllerObserver`

### Layouts

This module introduces the following layouts handle in the `view/adminhtml/layout` directory:

- `adminhtml_notification_index`

For more information about a layout in Magento 2, see the [Layout documentation](http://devdocs.magento.com/guides/v2.3/frontend-dev-guide/layouts/layout-overview.html).

### UI components

You can extend admin notifications using the configuration file in `view/adminhtml/ui_component/notification_area.xml`

For information about a UI component in Magento 2, see [Overview of UI components](http://devdocs.magento.com/guides/v2.3/ui_comp_guide/bk-ui_comps.html).