ENDOC-579B updates for blueprint tutorial & static resources #595
Conversation
| # Entando Blueprint Features | ||
|
|
||
| The Entando Blueprint makes it easier and faster to customize your application by generating controllers, repositories, services, and micro frontends for your entity. It means generating those project files in minutes, simply by answering questions that define the parameters of your application. | ||
| The Entando Blueprint is an easier and faster way to customize your application by generating controllers, repositories, services, and micro frontends for your entity. The project files are generated in minutes, by entering data that define the parameters of your application. |
There was a problem hiding this comment.
what is the rule for the comma here? comma if following clause isn't necessary to complete the sentence/message and no comma if it is? (i agree with the comma, just confirming)
There was a problem hiding this comment.
I think a comma is needed if what comes after is not required for understanding the first clause. If it's just additional information, a comma needed.
| For more information about custom events and widget communication, | ||
| please refer to the section on [Widget communication](../../tutorials/create/mfe/communication.md). | ||
| For more information about custom events and MFE communication, | ||
| please refer to the page on [Communicate Between Micro Frontends](../../tutorials/create/mfe/communication.md). |
There was a problem hiding this comment.
page on -> page (no "on")
| `react-testing-library`, but developers are free to upgrade and use any | ||
| tool desired. Tests and mocks are at `detailsWidget/src/components/`. | ||
| tool desired. Tests and mocks are located in each of the microfrontends' `/src/components/` directories. |
There was a problem hiding this comment.
this reads as there are multiple directories per MFE; is that right? What about "The tests and mocks for each micro frontend are located in its /src/components/ directory" (avoids confusing possessive and plurality)
| ## Static Resources | ||
|
|
||
| The `resources` folder in the `platform` directory contains all static resources. Files inside this folder will be uploaded to Entando with the same structure. | ||
| The `resources` folder in the `platform` directory contains all static resources. These files will be uploaded to Entando with the same structure, found in the App Builder File Browser public folder. |
There was a problem hiding this comment.
"with the same structure" - i'm expecting that structure to be referenced, like "with the same structure as"; "with" -> "using" clarifies this (minor but makes a difference to me)
| <link rel="shortcut icon" href="<@wp.resourceURL />your-bundle-id/images/favicon.ico" type="image/x-icon"/> | ||
| <script type="application/javascript" src="<@wp.resourceURL />your-bundle-id/js/script.js"></script> | ||
| Check line 65 too --> | ||
| To use static files in a Widget or Page Template, use the FTL tag `<@wp.resourceURL />` with your particular BUNDLE-CODE. YOUR-BUNDLE-CODE is a unique identifier that provides access to each bundle's resources. |
There was a problem hiding this comment.
i see why you left YOUR out of the first reference to this placeholder, but changing the placeholder text probably isn't the best way to go. i think "with your particular BUNDLE-CODE" -> "with YOUR-BUNDLE-CODE" is still very clear
There was a problem hiding this comment.
It bothered me too but it was repetitive. And combining the sentences made it too complicated. Edited
| To use static files in a Widget or Page Template, use the FTL tag `<@wp.resourceURL />` with your particular BUNDLE-CODE. YOUR-BUNDLE-CODE is a unique identifier that provides access to each bundle's resources. | ||
|
|
||
| #### Determine YOUR-BUNDLE-CODE | ||
| 1. Use the ent CLI to fetch YOUR-BUNDLE-ID first: |
There was a problem hiding this comment.
omit "first" (by definition this is step 1 and it's unnecessary)
There was a problem hiding this comment.
added not because of the steps but because there might be confusion between bundle-code and bundle-id. Edited to clarify
| @@ -43,7 +47,7 @@ ent jhipster --blueprints=entando | |||
| - `Which *development* database would you like to use?` (H2 with disk-based persistence) | |||
| - `Which cache do you want to use? (Spring cache abstraction)` (Caffeine (local cache, for a single node)) | |||
| - `Do you want to use Hibernate 2nd level cache?` (Yes) | |||
| - `Which other technologies would you like to use?` (**Don't select any other technologies**) | |||
| - `Which other technologies would you like to use?` (Don't select any other technologies) | |||
| - `Which BE dependencies do you want to use?` (Dependencies maintained by Entando (entando/entando-bundle-bom)) | |||
| - `Would you like to generate micro frontends when creating entities?` (Always) | |||
| - `Would you like to enable internationalization support` (Up to you) | |||
There was a problem hiding this comment.
did you also see that the parenthesis entry for pagination is different than we have currently? i had made a note to update it but wanted to check with you
There was a problem hiding this comment.
I left it as is, because the parenthesis are there to signify what to answer, not so much as a duplicate of what is printed on the console. I think it's clearer that way. But what entry for pagination?
There was a problem hiding this comment.
no i agree about the parentheses prompts; no changes suggested. i just meant that the pagination prompt i see reads "Yes, with infinite scroll and sorting headers" - super minor but different from what it used to be
| ``` | ||
| It should return an 8 digit string of numbers and letters, e.g. bundle-id=8785d979. | ||
|
|
||
| 2. YOUR-BUNDLE-CODE is YOUR-BUNDLE-NAME plus YOUR-BUNDLE-ID: |
There was a problem hiding this comment.
add dash between name and id
after the review, will copy over to next version
@nshaw, can you read over blueprint-features.md to check technical info is correct?