ENDOC-545-B new branch for Run-local #580

jyunmitch · 2022-09-28T18:49:04Z

No description provided.

Lyd1aCla1r3 · 2022-09-28T18:57:34Z

vuepress/docs/next/tutorials/create/ms/run-local.md

 ```
-3. Startup one or more of the frontend widgets, each from its own shell. You can stop the application using `Ctrl+C`. This command runs React in development mode so any changes you make to the source files should be immediately seen in the browser.
+2. Start up the Spring Boot application `conference-ms`. The logs will display in the console and you can stop the application with `Ctrl+C`. Keep the microservice running while the MFEs run.


"while the MFEs run" doesn't feel right here, like the MFEs will run to completion instead of continuing to run until the user stops them. in the latter case "while the MFEs are running" works better, implying user oversight and not a timed or event driven process that will end on its own

Lyd1aCla1r3 · 2022-09-28T18:59:34Z

vuepress/docs/next/tutorials/create/ms/run-local.md

+If you are not logged in, you'll be redirected to do so. Log in using the following credentials. 
+* Username: user 
+* Password: user\
+Once logged in, you will see the table widget with some generated data.


replace "some" with a more precise and descriptive term. sample data? default? "some" doesn't give any insight into where the data is coming from, how/if it can be altered, what kind of data to expect, etc.

Lyd1aCla1r3 · 2022-09-28T19:43:12Z

vuepress/docs/next/tutorials/create/ms/run-local.md


-#### Form Widget notes:
+1.  If you are still running the previous micro frontend, click `Ctrl+C` to end the process


to avoid the issue of specifying / not specifying the previous mfe, especially since this applies to any mfe and not one in particular, maybe just rephrase the instruction in the context of why it's important, like you need to ensure the localhost port is available to test the current mfe?

I don't think it's so complex that it needs to be pointed out

i guess it depends on the audience. not knowing much about how things work the user wouldn't realize that the whole point is to free up the port. i kind of think it's worth noting, just tacking that on the end of the sentence for clarity, but your call

Lyd1aCla1r3 · 2022-09-28T19:47:13Z

vuepress/docs/next/tutorials/create/ms/run-local.md

-3. Install and start your widget with the command:
-
-        npm install && npm start
+The form to enter the name and location for conferences should open in your browser. You may enter and save new data to see it in the other MFEs.


"of conferences" (not for)

something like "the data you enter and save will appear in the other MFEs" avoids the singular awkwardness and flows better and avoids the implication that changing the data in other MFEs is for its own sake, just to see the updates

it's really irrelevant whether it's singular or plural and also a style thing

it's interpretation, not style

Lyd1aCla1r3 · 2022-09-28T19:47:31Z

vuepress/docs/next/tutorials/create/ms/run-local.md


-If you want to modify a different row in the database, edit the `index.html` file in the public folder `ui/widgets/YOUR-ENTITY-NAME/detailsWidget/public`. Change the `id` attribute in this line:
+1. If you are running the previous micro frontend, click `Ctrl+C` to end the process


same comment

Lyd1aCla1r3 · 2022-09-28T19:48:12Z

vuepress/docs/next/tutorials/create/ms/run-local.md

-   '-Dkeycloak.migration.strategy=IGNORE_EXISTING',
-   ```   
-   * In the same file, add a persistent volume under `volumes`:
+2. In this blueprint generated project, Docker Compose persists Keycloak data across restarts by default. If you want your data to reset on restarts:


blueprint-generated

Lyd1aCla1r3 · 2022-09-28T19:48:26Z

vuepress/docs/next/tutorials/create/ms/run-local.md

-   * In the same file, add a persistent volume under `volumes`:
+2. In this blueprint generated project, Docker Compose persists Keycloak data across restarts by default. If you want your data to reset on restarts:
+
+   * Edit the `svc/keycloak.yml` file. Replace `-Dkeycloak.migration.strategy=IGNORE_EXISTING`,


why is the comma included in the edit? can just say replace ignore... with overwrite... ?

comma is part of the code, it should be inside the backtick. It's easier/clearer to explain a whole line than a part of one. And it's easier to compare what changed

Lyd1aCla1r3 · 2022-09-28T19:50:26Z

vuepress/docs/next/tutorials/create/ms/run-local.md

-   * Keycloak changes should now be persistent. You can reset your Keycloak database by emptying the `src/main/docker/keycloak-db` directory and restarting the container.
+   * Keycloak should now reset every time you restart.
+
+2. Error `User is not authenticated` : If you see this message after starting the MFEs, it is likely that your Keycloak application is not running or the `.env.local` file is not configured properly. Check if Keycloak is running; otherwise, update the configuration in `microservice/conference-x/.env.local`.


would rephrase "if you see"; whether or not you see it is different from whether or not it's generated

I think this is really down in the weeds... and a style issue

kind of. more about precision

Lyd1aCla1r3 · 2022-09-28T20:32:32Z

vuepress/docs/next/tutorials/create/ms/run-local.md

@@ -18,7 +18,7 @@ The following steps utilize the ent bundle CLI.
 ``` sh
 ent bundle svc start keycloak
 ```
-2. Start up the Spring Boot application `conference-ms`. The logs will display in the console and you can stop the application with `Ctrl+C`. Keep the microservice running while the MFEs run.
+2. Start up the Spring Boot application `conference-ms`. The logs will display in the console and you can stop the application with `Ctrl+C`. Keep the microservice running while the MFEs are run.


my vote is "MFEs" are running (common phrasing/understanding trumps the word repetition) but if you're set against that then "MFEs run" like you had before

the run here is used in the command sense of the word, as in run the command. The tutorial is about running the components. I think this is fine and more accurate.

i can appreciate that, but i think it's either "while the MFEs are running" or "when the MFEs are run"... "while" implies continued duration, whereas executing a command is done in an instant

ENDOC-545-B new branch for Run-local

e06b580

jyunmitch requested review from nshaw and Lyd1aCla1r3 September 28, 2022 18:49

Lyd1aCla1r3 reviewed Sep 28, 2022

View reviewed changes

ENDOC-545-B edits

e386f4b

Lyd1aCla1r3 reviewed Sep 28, 2022

View reviewed changes

Lyd1aCla1r3 self-requested a review September 29, 2022 15:14

Lyd1aCla1r3 approved these changes Sep 29, 2022

View reviewed changes

jyunmitch merged commit 24590cb into main Sep 29, 2022

jyunmitch deleted the ENDOC-545-B branch September 29, 2022 15:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENDOC-545-B new branch for Run-local #580

ENDOC-545-B new branch for Run-local #580

jyunmitch commented Sep 28, 2022

Lyd1aCla1r3 Sep 28, 2022

Lyd1aCla1r3 Sep 28, 2022

Lyd1aCla1r3 Sep 28, 2022

jyunmitch Sep 28, 2022 •

edited

Loading

Lyd1aCla1r3 Sep 28, 2022

Lyd1aCla1r3 Sep 28, 2022

jyunmitch Sep 28, 2022 •

edited

Loading

Lyd1aCla1r3 Sep 28, 2022

Lyd1aCla1r3 Sep 28, 2022

Lyd1aCla1r3 Sep 28, 2022

Lyd1aCla1r3 Sep 28, 2022

jyunmitch Sep 28, 2022 •

edited

Loading

Lyd1aCla1r3 Sep 28, 2022

jyunmitch Sep 28, 2022

Lyd1aCla1r3 Sep 28, 2022

Lyd1aCla1r3 Sep 28, 2022

jyunmitch Sep 28, 2022

Lyd1aCla1r3 Sep 28, 2022


		#### Form Widget notes:
		1. If you are still running the previous micro frontend, click `Ctrl+C` to end the process


		If you want to modify a different row in the database, edit the `index.html` file in the public folder `ui/widgets/YOUR-ENTITY-NAME/detailsWidget/public`. Change the `id` attribute in this line:
		1. If you are running the previous micro frontend, click `Ctrl+C` to end the process

ENDOC-545-B new branch for Run-local #580

ENDOC-545-B new branch for Run-local #580

Conversation

jyunmitch commented Sep 28, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jyunmitch Sep 28, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jyunmitch Sep 28, 2022 • edited Loading

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

jyunmitch Sep 28, 2022 • edited Loading

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

jyunmitch Sep 28, 2022 •

edited

Loading

jyunmitch Sep 28, 2022 •

edited

Loading

jyunmitch Sep 28, 2022 •

edited

Loading