From 22d3f634c899a1522f0904318df3cbefa6af727f Mon Sep 17 00:00:00 2001 From: Ryan Cohen Date: Tue, 11 Jun 2024 12:15:16 -0400 Subject: [PATCH 1/5] CEXT-3302: Adding additional events:metadata:populate info --- src/pages/events/commands.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/pages/events/commands.md b/src/pages/events/commands.md index c99736f8..77eb594e 100644 --- a/src/pages/events/commands.md +++ b/src/pages/events/commands.md @@ -132,7 +132,13 @@ bin/magento events:registrations:list -vv ## Create event metadata in Adobe I/O -The `events:metadata:populate` command creates event metadata based on XML and application configurations. +The `events:metadata:populate` command creates event metadata based on XML and application configurations. This metadata gets linked to the configured event provider. + +Event metadata is automatically created for new event subscriptions when the [`events:subscribe` command](#subscribe-to-an-event) is run and synchronized for events registered in `io_events.xml` files or `config.php` when the `setup:upgrade` command runs. Cases where creating event metadata using the `events:metadata:populate` command would be useful include the following: + +* You have configured an event provider after an `io_events.xml` file was pushed to your cloud instance and a redeployment has not occurred since + +* You have not run `setup:upgrade` since adding an `io_events.xml` file to your on-premise instance ### Usage From b9b57c5453985e3a8ef7dc84de1040cefc470eff Mon Sep 17 00:00:00 2001 From: Ryan Cohen Date: Tue, 11 Jun 2024 15:15:32 -0400 Subject: [PATCH 2/5] CEXT-3302: Adding mention of manual config.php edits --- src/pages/events/commands.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/pages/events/commands.md b/src/pages/events/commands.md index 77eb594e..45686d40 100644 --- a/src/pages/events/commands.md +++ b/src/pages/events/commands.md @@ -140,6 +140,8 @@ Event metadata is automatically created for new event subscriptions when the [`e * You have not run `setup:upgrade` since adding an `io_events.xml` file to your on-premise instance +* You manually edited the event subscriptions configuration in `app/etc/config.php` + ### Usage `events:metadata:populate` From df5a5eb960cbf39637e0d864a51d82d3607003bc Mon Sep 17 00:00:00 2001 From: Jared Hoover <98363870+jhadobe@users.noreply.github.com> Date: Wed, 12 Jun 2024 16:21:50 -0500 Subject: [PATCH 3/5] Apply suggestions from code review --- src/pages/events/commands.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/src/pages/events/commands.md b/src/pages/events/commands.md index 45686d40..aeda8b9c 100644 --- a/src/pages/events/commands.md +++ b/src/pages/events/commands.md @@ -134,13 +134,12 @@ bin/magento events:registrations:list -vv The `events:metadata:populate` command creates event metadata based on XML and application configurations. This metadata gets linked to the configured event provider. -Event metadata is automatically created for new event subscriptions when the [`events:subscribe` command](#subscribe-to-an-event) is run and synchronized for events registered in `io_events.xml` files or `config.php` when the `setup:upgrade` command runs. Cases where creating event metadata using the `events:metadata:populate` command would be useful include the following: +Event metadata is automatically created for new event subscriptions when you run the [`events:subscribe` command](#subscribe-to-an-event) and synchronize events registered in `io_events.xml` files or `config.php` when the `setup:upgrade` command runs. In the following situations, we recommend creating event metadata using the `events:metadata:populate` command: +- You have configured an event provider after an `io_events.xml` file was pushed to your cloud instance and a redeployment has not occurred since this change. -* You have configured an event provider after an `io_events.xml` file was pushed to your cloud instance and a redeployment has not occurred since +- You have not run `setup:upgrade` since adding an `io_events.xml` file to your on-premise instance. -* You have not run `setup:upgrade` since adding an `io_events.xml` file to your on-premise instance - -* You manually edited the event subscriptions configuration in `app/etc/config.php` +- You manually edited the event subscriptions configuration in `app/etc/config.php`. ### Usage From d9b620a637cfd2979592de3bd79bc7fcc9030b30 Mon Sep 17 00:00:00 2001 From: Jared Hoover <98363870+jhadobe@users.noreply.github.com> Date: Wed, 12 Jun 2024 16:25:34 -0500 Subject: [PATCH 4/5] Apply suggestions from code review --- src/pages/events/commands.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/pages/events/commands.md b/src/pages/events/commands.md index aeda8b9c..52bffd18 100644 --- a/src/pages/events/commands.md +++ b/src/pages/events/commands.md @@ -135,10 +135,9 @@ bin/magento events:registrations:list -vv The `events:metadata:populate` command creates event metadata based on XML and application configurations. This metadata gets linked to the configured event provider. Event metadata is automatically created for new event subscriptions when you run the [`events:subscribe` command](#subscribe-to-an-event) and synchronize events registered in `io_events.xml` files or `config.php` when the `setup:upgrade` command runs. In the following situations, we recommend creating event metadata using the `events:metadata:populate` command: -- You have configured an event provider after an `io_events.xml` file was pushed to your cloud instance and a redeployment has not occurred since this change. +- You have configured an event provider after an `io_events.xml` file was pushed to your cloud instance and a redeployment has not occurred since this change. - You have not run `setup:upgrade` since adding an `io_events.xml` file to your on-premise instance. - - You manually edited the event subscriptions configuration in `app/etc/config.php`. ### Usage From 81de9ebdc06ee0087f9270f8995743e9f887db0a Mon Sep 17 00:00:00 2001 From: Jared Hoover <98363870+jhadobe@users.noreply.github.com> Date: Wed, 12 Jun 2024 16:48:35 -0500 Subject: [PATCH 5/5] Apply suggestions from code review --- src/pages/events/commands.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/pages/events/commands.md b/src/pages/events/commands.md index 52bffd18..292c8f4c 100644 --- a/src/pages/events/commands.md +++ b/src/pages/events/commands.md @@ -136,9 +136,9 @@ The `events:metadata:populate` command creates event metadata based on XML and a Event metadata is automatically created for new event subscriptions when you run the [`events:subscribe` command](#subscribe-to-an-event) and synchronize events registered in `io_events.xml` files or `config.php` when the `setup:upgrade` command runs. In the following situations, we recommend creating event metadata using the `events:metadata:populate` command: -- You have configured an event provider after an `io_events.xml` file was pushed to your cloud instance and a redeployment has not occurred since this change. -- You have not run `setup:upgrade` since adding an `io_events.xml` file to your on-premise instance. -- You manually edited the event subscriptions configuration in `app/etc/config.php`. +* You have configured an event provider after an `io_events.xml` file was pushed to your cloud instance and a redeployment has not occurred since this change. +* You have not run `setup:upgrade` since adding an `io_events.xml` file to your on-premise instance. +* You manually edited the event subscriptions configuration in `app/etc/config.php`. ### Usage