ENDOC-566 bundle details page #569

jyunmitch · 2022-09-08T22:16:44Z

@Lyd1aCla1r3 lots of changes in second commit so will need to look there

vuepress/docs/next/docs/curate/bundle-details.md

nshaw

This is a start, I'm guessing I'll have more ideas on the next round. Apologies in advance.

vuepress/docs/next/docs/curate/bundle-details.md

vuepress/docs/next/docs/create/component-gen-tech.md

Lyd1aCla1r3 · 2022-09-14T20:07:59Z

vuepress/docs/next/docs/create/component-gen-tech.md

@@ -5,7 +5,7 @@ When generating a microservice using the Entando Component Generator there are a
 * Microservice code
  * The Component Generator currently only supports the generation of Spring Boot microservices but will support the generation of Quarkus based services soon. 
  * If you're interested in using Quarkus in your Entando app, contact us on the [Forum](https://forum.entando.org/) or [Community Slack](https://join.slack.com/t/entandocommunity/shared_invite/zt-g609owdv-2K~YRh8zrI6lqlWo4aFWUw) and we'll help you get started.
-  * If you're considering non-Java based microservices, [here is a definition of an Entando plugin](../curate/bundle-details.md#plugin), including information on the runtime contract required to use them. 
+  * If you're considering non-Java based microservices, [here is a definition of an Entando plugin](../curate/bundle-details.md#microservices-specifications), including information on the runtime contract required to use them. 
 * Database type
  * Entando recommends standardizing your choice of database to simplify operational maintenance but you do have the ability to use different databases for different microservices if you choose.


omit "if you choose" (redundant and sentence is already quite long without punctuation to break it up)

Lyd1aCla1r3 · 2022-09-14T20:09:21Z

vuepress/docs/next/docs/create/component-gen-tech.md

@@ -5,7 +5,7 @@ When generating a microservice using the Entando Component Generator there are a
 * Microservice code
  * The Component Generator currently only supports the generation of Spring Boot microservices but will support the generation of Quarkus based services soon. 


is this true? should we either put a date/rev for when to expect this or kill it to not make vague promises?

Let's drop the quarkus statement. We've been saying that for years.

bypassing all comments for this document. This document needs an update in general but with so much to finish for 7.1, I have to prioritize

Lyd1aCla1r3 · 2022-09-14T20:11:12Z

vuepress/docs/next/docs/create/component-gen-tech.md

@@ -5,7 +5,7 @@ When generating a microservice using the Entando Component Generator there are a
 * Microservice code
  * The Component Generator currently only supports the generation of Spring Boot microservices but will support the generation of Quarkus based services soon. 
  * If you're interested in using Quarkus in your Entando app, contact us on the [Forum](https://forum.entando.org/) or [Community Slack](https://join.slack.com/t/entandocommunity/shared_invite/zt-g609owdv-2K~YRh8zrI6lqlWo4aFWUw) and we'll help you get started.
-  * If you're considering non-Java based microservices, [here is a definition of an Entando plugin](../curate/bundle-details.md#plugin), including information on the runtime contract required to use them. 
+  * If you're considering non-Java based microservices, [here is a definition of an Entando plugin](../curate/bundle-details.md#microservices-specifications), including information on the runtime contract required to use them. 
 * Database type
  * Entando recommends standardizing your choice of database to simplify operational maintenance but you do have the ability to use different databases for different microservices if you choose.
  * Supported choices are none, MySQL, and Postgres. Enterprise customers can choose Oracle but should contact Entando Support for details.


is "Entando Support" a thing? should we link this to the appropriate contact section?

I'd leave it as-is. It's a common term and if they have a subscription they should know how.

Lyd1aCla1r3 · 2022-09-14T20:13:15Z

vuepress/docs/next/docs/curate/bundle-comparison.md

@@ -20,7 +20,7 @@ For specifications on docker-based bundles, see the [Bundle Details](bundle-deta
 |`descriptorVersion`| v1| v5
 | Bundle Specifications |Defined with descriptor files | Built with [ent bundle CLI](../getting-started/ent-bundle.md) tool


Defined by

Built with the Entando Bundle CLI

trying to keep this column as short as possible. so not including every article in the fragments. I don't think it takes anything away from understanding

left with as is, doesn't change meaning

Lyd1aCla1r3 · 2022-09-15T15:48:02Z

vuepress/docs/next/docs/curate/bundle-details.md

+|`deploymentBaseName`|String|No||Used for defining custom pod names|
+|`roles`|String[]|No||Exposed security roles|
+|`env`|[EnvironmentVariable[]](#environment-variables-specification)|No||Required environment variables|
+|`commands`|Command[]|No||Custom commands definitions|


command (not plural)

it can be plural, added parenthesis

Lyd1aCla1r3 · 2022-09-15T15:48:25Z

vuepress/docs/next/docs/curate/bundle-details.md

+|`dbms`|Enum|No|*none  *embedded  *postgresql  *mysql  *oracle|DBMS required by the MS to provide services|
+|`ingressPath`|String|No||Custom ingress path|
+|`healthCheckPath`|String|No||Endpoint for a health check|
+|`deploymentBaseName`|String|No||Used for defining custom pod names|


used to define

Lyd1aCla1r3 · 2022-09-15T15:58:33Z

vuepress/docs/next/docs/curate/bundle-details.md

+|Name|Type|Required|Possible Value|Description|
+|:-|:-|:-|:-|:------------------------|
+|`name`|String|Yes||Name|
+|`type`|Enum|Yes|*internal  *external| Kind of claim with reference to bundle |


"type of" instead of "kind of" ("kind of" reads like "sort of")

I thought that too but using the same word to describe the thing you're describing is not recommended. reworded

Lyd1aCla1r3 · 2022-09-15T15:59:02Z

vuepress/docs/next/docs/curate/bundle-details.md

+|:-|:-|:-|:-|:------------------------|
+|`name`|String|Yes||Name|
+|`type`|Enum|Yes|*internal  *external| Kind of claim with reference to bundle |
+|`serviceName`|String|Yes||Microservice name into the bundle|


name into the bundle? that's confusing ??

noticed that too, but it came from Notion

Notion is confusing. I'm changing it.

vuepress/docs/next/docs/curate/bundle-details.md

nshaw · 2022-09-15T21:26:10Z

vuepress/docs/next/docs/curate/bundle-details.md

    pages/  
-  svc/     <= auxiliary services 
-    keycloak.yml
+  svc/     <= auxiliary services for local development 


@Lyd1aCla1r3 correct, it's only for local work

nshaw · 2022-09-15T21:28:54Z

vuepress/docs/next/docs/curate/bundle-details.md

+      "commands": { "build": "custom-command" }
+    }
+```
+#### mfeConfig Specifications


Something is wrong here. mfeConfig isn't a thing. configMfe is a string indicating the custom element for the corresponding config MFE. And what is listed in the mfeConfig section below should just be inline in the microfrontend section. You cannot have an array of mfeConfig containing params, contextParams, systemParams, you can just have the actual params, contextParams, and systemParams under the microfrontend.

nshaw · 2022-09-15T21:31:55Z

vuepress/docs/next/docs/curate/bundle-details.md

+    }
+  },
+  "contextParams": {
+    "page_code": "${page_code}",


I think we need to remove all of the ${page_code] bits here in lines 186-188. I think that was pseudo-code used by Engineering to indicate their implementation. The actual working code (although I'm setting up to test it) doesn't include values. See https://github.com/entando/entando-showcase-bundle/blob/master/entando.json for a real example.

ENDOC-566 bundle details v2

ENDOC-566 bundle details tech draft

cf6968f

jyunmitch requested a review from nshaw September 8, 2022 22:16

jyunmitch commented Sep 9, 2022

View reviewed changes

vuepress/docs/next/docs/curate/bundle-details.md Outdated Show resolved Hide resolved

nshaw reviewed Sep 9, 2022

View reviewed changes

vuepress/docs/next/docs/curate/bundle-details.md Outdated Show resolved Hide resolved

ENDOC-566 tech review edits

716c7ec

jyunmitch requested a review from Lyd1aCla1r3 September 12, 2022 21:04

jyunmitch changed the title ~~ENDOC-566 bundle details tech draft~~ ENDOC-566 bundle details page Sep 12, 2022

Lyd1aCla1r3 reviewed Sep 15, 2022

View reviewed changes

nshaw suggested changes Sep 15, 2022

View reviewed changes

jyunmitch and others added 4 commits September 16, 2022 17:11

ENDOC-566 round 2 edit

e05c556

ENDOC-566 Refine the bundle details

62fff2c

ENDOC-566 Refine the bundle details

93ff70f

Merge pull request #573 from entando/ENDOC-566-bundle-details-v2

31a5b5d

ENDOC-566 bundle details v2

nshaw approved these changes Sep 20, 2022

View reviewed changes

nshaw merged commit ae5ccd9 into main Sep 20, 2022

nshaw deleted the ENDOC-566 branch September 20, 2022 16:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENDOC-566 bundle details page #569

ENDOC-566 bundle details page #569

jyunmitch commented Sep 8, 2022 •

edited

Loading

nshaw left a comment

Lyd1aCla1r3 Sep 14, 2022

Lyd1aCla1r3 Sep 14, 2022

nshaw Sep 15, 2022

jyunmitch Sep 15, 2022

Lyd1aCla1r3 Sep 14, 2022

nshaw Sep 15, 2022

Lyd1aCla1r3 Sep 14, 2022

jyunmitch Sep 15, 2022

Lyd1aCla1r3 Sep 15, 2022

jyunmitch Sep 16, 2022

Lyd1aCla1r3 Sep 15, 2022

Lyd1aCla1r3 Sep 15, 2022

jyunmitch Sep 16, 2022

Lyd1aCla1r3 Sep 15, 2022

jyunmitch Sep 16, 2022

nshaw Sep 19, 2022

nshaw Sep 15, 2022

nshaw Sep 15, 2022

nshaw Sep 15, 2022

		@@ -5,7 +5,7 @@ When generating a microservice using the Entando Component Generator there are a
		* Microservice code
		* The Component Generator currently only supports the generation of Spring Boot microservices but will support the generation of Quarkus based services soon.

		@@ -20,7 +20,7 @@ For specifications on docker-based bundles, see the [Bundle Details](bundle-deta
		\|`descriptorVersion`\| v1\| v5
		\| Bundle Specifications \|Defined with descriptor files \| Built with [ent bundle CLI](../getting-started/ent-bundle.md) tool

ENDOC-566 bundle details page #569

ENDOC-566 bundle details page #569

Conversation

jyunmitch commented Sep 8, 2022 • edited Loading

nshaw left a 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

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 commented Sep 8, 2022 •

edited

Loading