ENDOC-507 Widget communication #575

Lyd1aCla1r3 · 2022-09-20T01:16:09Z

No description provided.

jyunmitch · 2022-09-22T19:03:53Z

vuepress/docs/next/tutorials/create/mfe/communication.md

-``` bash
-npm start
-```
+## Modify the Publisher MFE

 ### Create Custom Event


Create the Custom Event

the original didn't use articles in the sub headers

noticed the headers below used them

i liked it better with the articles and started adding them in but then second-guessed it and reverted; i guess i missed a couple. changed my mind again tho, so back to using articles

jyunmitch · 2022-09-22T19:08:02Z

vuepress/docs/next/tutorials/create/mfe/communication.md


-Update `publisher-widget/src/index.js`.
+2. To import the custom element, update `publisher-widget/src/index.js`:


I'm guessing you add the two import statements below but 'update' seems too vague.

And this forces the reader to spend more time comparing the doc to this snippet, instead of just copying it and inserting it.

no. update means replace the contents. in other tutorials we've edited this language to make that explicit but i feel like the intent is understood so i left as-is. to expand upon it seems unnecessary because if you're familiar with the file content update=replace should be obvious

@jyunmitch struggling with this one... this tutorial is identified as intermediate wrt our learning paths... i asked nathan to weigh in

jyunmitch · 2022-09-22T19:09:23Z

vuepress/docs/next/tutorials/create/mfe/communication.md


 ``` js
 import './index.css';
 import './PublisherWidgetElement';
 ```

-#### Test Custom Element
+3. To test the MFE, update `publisher-widget/public/index.html` and view the app in the browser:


would clarify what to do with body statement below. Again update is too vague and they would have to kind of guess if they did the right thing to add or replace.

jyunmitch · 2022-09-22T19:10:24Z

vuepress/docs/next/tutorials/create/mfe/communication.md


-Update `publisher-widget/src/App.js`.
+1. Update `publisher-widget/src/App.js` to dispatch an event:


same here with regard to update, it can simply say add

jyunmitch · 2022-09-22T19:12:15Z

vuepress/docs/next/tutorials/create/mfe/communication.md

-#### Import Custom Element
-
-Update `subscriber-widget/src/index.js`.
+2. To import the custom element, update `subscriber-widget/src/index.js`:


same as above, update is vague

jyunmitch · 2022-09-22T19:14:49Z

vuepress/docs/next/tutorials/create/mfe/communication.md

    ...
  </body>
 ```

 ### Display Custom Event

-Update `subscriber-widget/src/App.js`.
+1. Update `subscriber-widget/src/App.js` to display the event:


again the same, are you supposed add the whole thing, bits of it, or what?

jyunmitch · 2022-09-22T19:17:35Z

vuepress/docs/next/tutorials/create/mfe/communication.md

-2. Open the `.env` file, and enter the `PUBLIC_URL` where the micro frontend will be hosted.
-
-Example:
+To add the publisher and subscriber MFEs to Entando, run the following commands from the root folder of each:


each reads like it's referencing publish and subscriber, not the MFEs, even though indirectly they are mfes but I was thinking what publisher directory?

jyunmitch · 2022-09-22T19:19:23Z

vuepress/docs/next/tutorials/create/mfe/communication.md


-1. Go to `Pages` → `Management`
+Set up the widgets on an existing page or [create your own page](../../compose/page-management.md). The following steps assume you'll use the `Home` page.


Set up >> place
thought it was referring to some configuration settings

jyunmitch · 2022-09-22T19:21:33Z

vuepress/docs/next/tutorials/create/mfe/communication.md


-6. In the `WIDGETS` sidebar on the right:
+6. From the `Widgets` tab in the right sidebar, drag your publisher and subscriber widgets into `Frame 1` and `Frame 2`


drag >> drag and drop
it doesn't matter which goes in which frame, right?

dragging the widget into the frame performs a drag and drop

it doesn't. the way we read from left to right, top to bottom would map to publisher on left/top but that's not worth mentioning

not everyone reads left to right. I would totally read this one to mean put it in any frame

true, all the more reason to omit specific placement from the instruction. placement has no impact on functionality and is not subject to any constraints; the user is free to place the widgets in the layout of their choice. because the widgets exhibit some causality, the user will likely place them according to convention for cause and effect

Lyd1aCla1r3 · 2022-09-22T19:59:42Z

@nshaw what are your thoughts on adding some language to clarify that update means replace the contents of? there's one instance where update means change a snippet, which would require different clarifying language. the instructions were clear to me as-is, so i'd assume any dev following this tutorial wouldn't need it spelled out??

nshaw · 2022-09-22T20:13:00Z

@Lyd1aCla1r3 I've definitely had people get confused on that one. It might be nice to use different language when you replace the whole file, versus adding/updating a section. It seems like this tutorial isn't quite as explicit as some tutorials in that sense.

Lydia Pedersen added 2 commits September 19, 2022 18:15

ENDOC-507 Widget communication

cbe6764

ENDOC-507 Update the communication tutorial

c05e48e

Lyd1aCla1r3 marked this pull request as ready for review September 22, 2022 01:24

Lyd1aCla1r3 requested review from jyunmitch and nshaw September 22, 2022 01:25

jyunmitch reviewed Sep 22, 2022

View reviewed changes

ENDOC-507 Apply PR feedback

c9640c3

nshaw approved these changes Sep 23, 2022

View reviewed changes

nshaw merged commit fce171e into main Sep 23, 2022

nshaw deleted the ENDOC-507 branch September 23, 2022 16:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENDOC-507 Widget communication #575

ENDOC-507 Widget communication #575

Lyd1aCla1r3 commented Sep 20, 2022

jyunmitch Sep 22, 2022

Lyd1aCla1r3 Sep 22, 2022

jyunmitch Sep 23, 2022

Lyd1aCla1r3 Sep 23, 2022

jyunmitch Sep 22, 2022

Lyd1aCla1r3 Sep 22, 2022

Lyd1aCla1r3 Sep 22, 2022

jyunmitch Sep 22, 2022

jyunmitch Sep 22, 2022

jyunmitch Sep 22, 2022

jyunmitch Sep 22, 2022

jyunmitch Sep 22, 2022

jyunmitch Sep 22, 2022

jyunmitch Sep 22, 2022

Lyd1aCla1r3 Sep 22, 2022

jyunmitch Sep 23, 2022

Lyd1aCla1r3 Sep 23, 2022

Lyd1aCla1r3 commented Sep 22, 2022

nshaw commented Sep 22, 2022


		Update `publisher-widget/src/index.js`.
		2. To import the custom element, update `publisher-widget/src/index.js`:


		Update `publisher-widget/src/App.js`.
		1. Update `publisher-widget/src/App.js` to dispatch an event:


		1. Go to `Pages` → `Management`
		Set up the widgets on an existing page or [create your own page](../../compose/page-management.md). The following steps assume you'll use the `Home` page.


		6. In the `WIDGETS` sidebar on the right:
		6. From the `Widgets` tab in the right sidebar, drag your publisher and subscriber widgets into `Frame 1` and `Frame 2`

ENDOC-507 Widget communication #575

ENDOC-507 Widget communication #575

Conversation

Lyd1aCla1r3 commented Sep 20, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Lyd1aCla1r3 commented Sep 22, 2022

nshaw commented Sep 22, 2022