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

Jump to bottom
Merged
merged 2 commits into from
Aug 15, 2019
Merged

Update Magento_AdminNotification module ReadMe #24129

merged 2 commits into from
Aug 15, 2019

Conversation

diazwatson
Copy link
Contributor

@diazwatson diazwatson commented Aug 14, 2019 •
edited
Loading

Description (*)

Updates ReadMe for the Magento_AdminNotification module.

Fixed Issues (if relevant)

  1. magento/devdocs README content for modules - work in M2 Code devdocs#4451: README content for modules - work in M2 Code

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • All automated tests passed successfully (all builds are green)

@m2-assistant
Copy link

m2-assistant bot commented Aug 14, 2019

Hi @diazwatson. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.3-develop instance - deploy vanilla Magento instance

In case you'd like to rerun tests use the following comments:

  • @magento run all tests - run all tests
  • @magento run { check name } - run a single test job (check name example: Static Tests build)

For more details, please, review the Magento Contributor Guide documentation.

@magento-engcom-team magento-engcom-team added Component: AdminNotification Release Line: 2.3 Partner: Space 48 Partner Space48 contribution partners-contribution Pull Request is created by Magento Partner labels Aug 14, 2019
@ghost ghost assigned ihor-sviziev Aug 14, 2019
@magento-engcom-team
Copy link
Contributor

Hi @ihor-sviziev, thank you for the review.
ENGCOM-5617 has been created to process this Pull Request
✳️ @ihor-sviziev, could you please add one of the following labels to the Pull Request?

Label Description
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests

@ihor-sviziev ihor-sviziev added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Aug 14, 2019
@engcom-Alfa engcom-Alfa self-assigned this Aug 14, 2019
@engcom-Alfa
Copy link
Contributor

QA not applicable

@engcom-Foxtrot engcom-Foxtrot self-assigned this Aug 14, 2019
jeff-matthews
jeff-matthews requested changes Aug 14, 2019
View reviewed changes
Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see minor editorial suggestions.

@ghost ghost assigned jeff-matthews Aug 14, 2019
@diazwatson diazwatson changed the title Update Admin Notification ReadMe Update Magento_AdminNotification module ReadMe Aug 15, 2019
@ihor-sviziev ihor-sviziev removed their assignment Aug 15, 2019
jeff-matthews
jeff-matthews approved these changes Aug 15, 2019
View reviewed changes
Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @diazwatson!

@magento-engcom-team
Copy link
Contributor

Hi @jeff-matthews, thank you for the review.
ENGCOM-5617 has been created to process this Pull Request

@diazwatson
Copy link
Contributor Author

Hi @jeff-matthews, thank for taking the time to review this PR.

dshevtsov
dshevtsov suggested changes Aug 15, 2019
View reviewed changes
app/code/Magento/AdminNotification/README.md

Before disabling or uninstalling this module, note that the Magento_Indexer module depends on this module.

For information about 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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change the link to https://...

app/code/Magento/AdminNotification/README.md
- `adminhtml_notification_index`
- `adminhtml_notification_block`

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change the link to https://...

app/code/Magento/AdminNotification/README.md

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

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change the link to https://...

@magento-engcom-team magento-engcom-team merged commit 1dad97c into magento:2.3-develop Aug 15, 2019
@m2-assistant
Copy link

m2-assistant bot commented Aug 15, 2019

Hi @diazwatson, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

magento-engcom-team pushed a commit that referenced this pull request Aug 15, 2019
@sidolov
ENGCOM-5617: Update Admin Notification ReadMe #24129
bac81c0
@magento-engcom-team magento-engcom-team added this to the Release: 2.3.4 milestone Aug 15, 2019
@diazwatson diazwatson deleted the ReadMe_AdminNotification branch August 15, 2019 22:47
@diazwatson diazwatson mentioned this pull request Aug 15, 2019
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dshevtsov dshevtsov dshevtsov requested changes

@ihor-sviziev ihor-sviziev ihor-sviziev approved these changes

@jeff-matthews jeff-matthews jeff-matthews approved these changes

Assignees

@jeff-matthews jeff-matthews

@engcom-Alfa engcom-Alfa

@engcom-Foxtrot engcom-Foxtrot

Labels
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Component: AdminNotification Partner: Space 48 Partner Space48 contribution partners-contribution Pull Request is created by Magento Partner Progress: accept Release Line: 2.3
Projects
None yet
Milestone
Release: 2.3.4
Development

Successfully merging this pull request may close these issues.
7 participants
@diazwatson @magento-engcom-team @engcom-Alfa @ihor-sviziev @dshevtsov @jeff-matthews @engcom-Foxtrot