ENDOC-575 Update the jhipster tutorial for Docker-based format in Ent… #581
Conversation
| 5. Install your Entando Bundle into your Entando Application(s) | ||
| 1. Set up a new bundle project | ||
| 2. Run the Entando Blueprint to create your components (Spring Boot microservice and optionally React micro frontends) | ||
| 3. Configure the bundle project to wire together the components. |
There was a problem hiding this comment.
remove period (no punctuation)
There was a problem hiding this comment.
Thinking that since these are not instructions but a layout of the process, they should be proper sentences. For a moment, thought they were instructions and was thinking, what, this is all I get for instructions?!
There was a problem hiding this comment.
we have been leaving bullets or numbered lists outlining a process unpunctuated on other pages. i think either way is fine, but suggested unpunctuated in this case because #3 is the only line item with a period, so changing it to align with the rest would be less effort than changing all the others to match
There was a problem hiding this comment.
I shifted the direction here since we have better docs on the overall process now.
|
|
||
| ## Prerequisites | ||
| Use the [Entando CLI](../../../docs/getting-started/entando-cli.md#check-the-environment) to verify environmental dependencies (e.g. Java, npm, git, JHipster, Entando Blueprint). | ||
| * Use the [Entando CLI](../../../docs/getting-started/entando-cli.md#check-the-environment) to verify environmental dependencies (e.g. Java, npm, git, JHipster, Entando Blueprint). |
There was a problem hiding this comment.
nothing wrong with this, but we've shifted to slight variations of the following:
Prerequisites
- A working instance of Entando
- Verify dependencies with the Entando CLI:
ent check-env develop
| ```shell | ||
| ent bundle init YOUR-PROJECT-NAME | ||
| ```` | ||
| 2. Change into the project directory |
There was a problem hiding this comment.
punctuate with a colon
|
|
||
| `Overwrite .gitignore?` | ||
| ## Generate the Components | ||
| 1. Use the entando cli to add a microservice to the project. This step creates the basic configuration and then the Entando Blueprint generates the service code in the following steps. |
There was a problem hiding this comment.
Entando CLI
would save the note on the service code for the step(s) that generate it; possible rephrase to "Use the Entando CLI to add a basic microservice configuration to the project:"
| ```shell | ||
| ent bundle ms add conference-ms --stack=spring-boot | ||
| ``` | ||
| 2. Change to the microservice directory |
There was a problem hiding this comment.
maybe replace "change to" with "shell into" or "navigate to"; punctuate with :
|
|
||
| Next you'll move the `/ui` and `/src/main/docker` files into the standard Entando bundle locations and then wire the MFEs and microservice together. | ||
|
|
||
| ## Finish configuring the bundle project |
There was a problem hiding this comment.
header seems to deviate from use of all caps
| Next you'll move the `/ui` and `/src/main/docker` files into the standard Entando bundle locations and then wire the MFEs and microservice together. | ||
|
|
||
| ## Finish configuring the bundle project | ||
| 1. Change back to the root directory of your project |
There was a problem hiding this comment.
same comment wrt "change"
punctuate with :
There was a problem hiding this comment.
I think change is fine, especially since cd is change directory
There was a problem hiding this comment.
"change back" sounds a little off out of this context, but given that, yes, it works
There was a problem hiding this comment.
I simplified this one. In other tutorials we dropped the cd commands and just led with "In x directory".
| ```shell | ||
| cd ../.. | ||
| ``` | ||
| 2. Edit the `entando.json` and update `microservices/conference-ms` to set the healthCheckPath and dbms. |
There was a problem hiding this comment.
I back-ticked these since lowercase dbms is the actual field name in the entando.json
| "dbms":"postgresql" | ||
| ``` | ||
|
|
||
| 3. Move the generated `conference-table` MFE into the correct location in the bundle project. If you chose a different entity name, you'll need to adjust these commands accordingly. |
There was a problem hiding this comment.
to the correct location (into the correct folder)
| ent bundle api add conference-form conference-api --serviceName=conference-ms --serviceUrl=http://localhost:8081 | ||
| ``` | ||
|
|
||
| 6. Finally, move the auxiliary services into place in the bundle project and enable the keycloak service for local tests. |
There was a problem hiding this comment.
refine "into place" to be clarified/precise
Keycloak
punctuate with :
There was a problem hiding this comment.
Back-ticked keycloak since the service name is lowercase.
| 3. Build an Entando Bundle from your components | ||
| 4. Deploy a [custom resource](../../../docs/consume/custom-resources.md) for your bundle into Kubernetes | ||
| 5. Install your Entando Bundle into your Entando Application(s) | ||
| The output of this tutorial is [a new bundle project](../../../docs/curate/bundle-details.md#bundle-development-process) with several components: |
There was a problem hiding this comment.
the first word of each bulleted line item below should be capitalized (or use 3 for the second bullet)
|
|
||
| 5. You'll be presented with a series of additional prompts pertaining to project configuration. These are echoed below, with the base values for this tutorial in parentheses. Input your preferences, except where a required entry is identified in **bold**. Note that the `Enter` key will select the default option. | ||
|
|
||
| 3. You'll be presented with a series of prompts pertaining to service generation. These are echoed below, with the base values for this tutorial in parentheses. Input your preferences, except where a required entry is identified in **bold**. Note that the `Enter` key will select the default option. |
There was a problem hiding this comment.
my questions/selections didn't match this exactly; i can show you what printed to the terminal
There was a problem hiding this comment.
@Lyd1aCla1r3 the questions can differ based on answers to some questions. I went through this with the latest blueprint and thought it was consistent but let's look at what you're seeing.
| * ```/bundle``` is used to assemble the project code into an Entando Bundle. | ||
| * ```/src/main/docker``` contains Docker files to help with local development environments. | ||
|
|
||
| Next, move the `/ui` and `/src/main/docker` files into the standard Entando bundle directories and then wire the MFEs to the Spring Boot microservice. |
There was a problem hiding this comment.
...where are the corresponding instructions?? not sure what to do here, or why this doesn't translate to numbered steps ??
There was a problem hiding this comment.
yep, confusing. I don't think this sentence is needed anymore.
| - `Would you like to generate micro frontends when creating entities?` (Always) | ||
| - `Would you like to enable internationalization support` (Up to you) | ||
| - `Please choose the native language of the application` (Up to you) | ||
| - `Besides JUnit and Jest, which testing frameworks would you like to use?` (Up to you) | ||
| - `Would you like to install other generators from the JHipster Marketplace?` (No) | ||
|
|
||
| 6. Next, add an Entity to your microservice and create the corresponding micro frontends. In this tutorial, `Conference` is the name of the entity that will be added to the application. | ||
| 4. Enter "Yes" when prompted with the following overwrite to resolve the conflict: |
There was a problem hiding this comment.
is this step still needed? (I think it was the case because the cli created a .gitignore file but now we run the bp in a separated folder, it should be different)
There was a problem hiding this comment.
@avdev4j The prompt was still showing up for me in my last test. We're planning to test one more time when the blueprint is finalized and can update the text to match then.
| - [Build and publish a project bundle](../pb/publish-project-bundle.md) to deploy your microservice and micro frontends to the Entando Component Repository | ||
| - Learn how to [run Blueprint-generated components locally in dev mode](./run-local.md) | ||
| - Discover the benefits and features of [the Entando Blueprint](../../../docs/create/blueprint-features.md) | ||
| 3. Now add an API claim to connect the `conference-table` MFE to the `conference-ms` microservice. The connection information is stored in the `entando-json`. |
| - `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 BE dependencies do you want to use?` (Dependencies maintained by Entando (entando/entando-bundle-bom)) | ||
| - `What name would you give to the bundle to share on an Entando Component Repository?` (Up to you) | ||
| - `Which is the organization name to use when publishing the docker image?` (**Enter the name of the organization where you are going to push your Docker image. If you're using your personal Docker hub account enter your username.**) <-- this can be changed later as needed |
There was a problem hiding this comment.
why were these two items removed? I still get them
…ando 7.1