ENDOC-536 new bundle classification #555

jyunmitch · 2022-08-24T19:36:56Z

No description provided.

vuepress/docs/next/docs/curate/bundle-version-types.md

nshaw · 2022-08-25T14:31:23Z

vuepress/docs/next/docs/curate/bundle-version-types.md

+|Bundle Thumbnail| Detailed inside the YAML bundle descriptor|Automatically setup with a jpg or png file named thumbnail in the bundle root folder.  e.g. thumbnail.png
+
+* Alternate page titles
+# Entando Bundle Version Comparison


I prefer this one of the 3. I don't love Version in the title for some reason (since bundles themselves have versions when published) but I don't have a better idea. In some ways this is a Feature Matrix like you get when you do insurance shopping. Entando Bundle Feature Matrix?

How about Entando Bundle Transition to 7.1?
Entando Bundle Transition from 7.0 to 7.1
How Entando Bundles changed from 7.0 to 7.1

Feature Matrix for Bundle Transition?

jyunmitch · 2022-08-25T19:25:57Z

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

@@ -0,0 +1,39 @@
+---


NOTE: changed file name...lost most of Nathan's comments but applied all of them here. The files are the same in this commit, I think

Lyd1aCla1r3 · 2022-08-25T21:40:18Z

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

+
+# Entando Bundle Transition to 7.1 
+
+Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based OCI bundles, and this page clarifies the differences between the two, along with the improvements that were made with the new release.


The Entando bundle -> The Entando Bundle

Docker-based -> docker-based

"Entando 7.1 implements a more modular approach to building apps with the ent bundle CLI orchestrating the management of project bundles." -> "Entando 7.1 implements a more modular approach to building apps with the ent bundle CLI**, which orchestrates** the management of project bundles." -- can we make this change so it's clear that the ent bundle tool is new? otherwise it could read that the ent bundle tool was modified wrt orchestration methods

"Entando Bundles went from git-based to Docker-based OCI bundles..." -- "went from" is a little ambiguous. could we make it clear that this bundle type was not overwritten, but instead a new kind of introduced? this reads like changes were made to the current bundle type, not that there are now two varieties

Lyd1aCla1r3 · 2022-08-25T21:46:21Z

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

+
+Some of the major improvements with the docker-based bundles are:
+* Simplified bundle directory structure
+* Just one source git repository required with Docker image repositories created automatically as needed


the wording here tripped me up... place "required" before "one" and add a comma? "Requires a single source git repository, with Docker image repositories created automatically as needed."

it would make the tense different from all others in list

one way to keep the tense and reword: "only one required Git source repository with Docker..." (also Git should be capitalized)

Lyd1aCla1r3 · 2022-08-25T21:46:44Z

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

+Some of the major improvements with the docker-based bundles are:
+* Simplified bundle directory structure
+* Just one source git repository required with Docker image repositories created automatically as needed
+* Optimized file storage and transfer using a layered file-system, beneficial for large projects


no hyphen - "layered file system"

Lyd1aCla1r3 · 2022-08-25T21:53:34Z

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

+|Attribute | [git-based bundles](../../../v7.0/docs/curate/ecr-bundle-details.md)| [docker-based bundles](ecr-bundle-details.md)|
+| :- | :-------------------- | :---------------------  |
+|`descriptorVersion`| v1| v5
+| Bundle specifications |Defined with descriptor files | Built with [ent bundle CLI](../getting-started/ent-bundle.md) tool


minor, but "defined by"

Lyd1aCla1r3 · 2022-08-25T23:37:35Z

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

+| :- | :-------------------- | :---------------------  |
+|`descriptorVersion`| v1| v5
+| Bundle specifications |Defined with descriptor files | Built with [ent bundle CLI](../getting-started/ent-bundle.md) tool
+| Versioning |Bundle version set by git tags |Bundle version set by Docker Tags. For MFEs, the version defaults to 1.0.0 unless set in the [entando.json](ecr-bundle-details.md). 


"Git tags" and "Docker tags" - uppercase for feature/platform & lowercase "tag"

Lyd1aCla1r3 · 2022-08-25T23:40:54Z

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

+|Export Bundle|`ent bundler`| Not Available 
+|JHipster Integrated Blueprint Project| `ent jhipster blueprint` creates [MFE & MS template project](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md)| [Convert Blueprint project to v5 bundle](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md) (TODO-change link to new tutorial)
+|APIs| Not Available | [Manage APIs with `ent bundle` commands](../getting-started/ent-api.md). MFEs can make API claims to MSs within the namespace
+||| MFEs support service discovery by using the property apiClaim


backtick "apiClaim" because it's a property ??

it's being used as a name of a thing, not referring to code?

Lyd1aCla1r3 · 2022-08-25T23:41:08Z

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

+|APIs| Not Available | [Manage APIs with `ent bundle` commands](../getting-started/ent-api.md). MFEs can make API claims to MSs within the namespace
+||| MFEs support service discovery by using the property apiClaim
+|Local Services |Not Available | Default services now include PostgreSQL, MySQL, and Keycloak. Additional services can be added with the [`ent bundle svc` commands](../getting-started/ent-svc.md).
+|MFE custom UI| Add with manual scripts| Custom UI is auto-generated in FTL format


autogenerated

looked it up and they are both used, about equally

Lyd1aCla1r3 · 2022-08-25T23:42:59Z

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

+||| MFEs support service discovery by using the property apiClaim
+|Local Services |Not Available | Default services now include PostgreSQL, MySQL, and Keycloak. Additional services can be added with the [`ent bundle svc` commands](../getting-started/ent-svc.md).
+|MFE custom UI| Add with manual scripts| Custom UI is auto-generated in FTL format
+|Data transfer | Manual | New ways to pass values or information to widgets, bundles, or expose in the APIs by [utilizing context parameters, system parameters and the ext variable](ecr-bundle-details.md).


sentence fragment is awkward - "or expose in the APIs..." what do you mean by this?

I think the APIs expose the values or information transferred, literally, probably in the browser or something like that

the verb changed so the subject needs to be reintroduced somehow... "New ways to pass values to widgets and bundles or expose information in APIs by..."

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

Lyd1aCla1r3 · 2022-08-25T23:45:47Z

vuepress/docs/next/docs/curate/bundle-version-types.md

+|Bundle Thumbnail| Detailed inside the YAML bundle descriptor|Automatically setup with a jpg or png file named thumbnail in the bundle root folder.  e.g. thumbnail.png
+
+* Alternate page titles
+# Entando Bundle Version Comparison


Feature Matrix for Bundle Transition?

Lyd1aCla1r3 · 2022-08-29T16:20:07Z

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

@@ -2,13 +2,13 @@
 sidebarDepth: 2
 ---

-# Entando Bundle Transition to 7.1 
+# Entando Bundle Transition to 7.1  Entando Bundle Evolution


i like this!

Lyd1aCla1r3 · 2022-08-29T16:21:42Z

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


-Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based OCI bundles, and this page clarifies the differences between the two, along with the improvements that were made with the new release.
+Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based OCI bundles. Though both systems are supported on Entando 7.1, this page clarifies the differences between the two, along with the improvements that were made with the new release.


Entando bundle -> Entando Bundle (2nd sentence)
Docker-based -> docker-based (4th line)
system is not the right word here. implementations is an option

I'll change it to methods, shorter than implementation

it's actually not a method, though... implementations is really the best word here. unless you want to use "bundle structures"

same comment as before applies to "went from"; don't know if you saw it. we need to make it clear that v1 and v5 bundles both exist, and that v1 bundles have not been converted over to v5. 7.1 introduces a new bundle format, but this does not impact existing bundles from 7.0 backwards. the conversion to turn v1 into v5 has to be done by the user

I think the statement that both methods are supported suffices here. To get into too much detail is not fruitful when they can see the table of differences just below. And Nathan thought the summary worked. I don't want to say anything about conversion because, 1. not may people will be doing it without Entando's support as Nathan said, and 2. it makes it sound cumbersome right off the bat.

And methods, processes, implementations, they can all work on some level. and since it was just talking about transport methods, thought that would also suffice.

jyunmitch · 2022-08-29T17:58:16Z

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

@@ -2,14 +2,13 @@
 sidebarDepth: 2
 ---

-# Bundle Evolution on Entando 7.1  
+# Bundle Evolution on Entando 7.1


new title, with more options below. vote on your favorite

nshaw

Can we add the link to this new page from the release notes in this PR or do you have that in a TODO somewhere?

ENDOC-536 new bundle classification

59df296

jyunmitch requested a review from nshaw August 24, 2022 19:36

jyunmitch commented Aug 25, 2022

View reviewed changes

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

nshaw reviewed Aug 25, 2022

View reviewed changes

ENDOC-536-version

9d39e85

jyunmitch commented Aug 25, 2022

View reviewed changes

jyunmitch requested a review from Lyd1aCla1r3 August 25, 2022 19:30

Lyd1aCla1r3 reviewed Aug 25, 2022

View reviewed changes

jyunmitch added 2 commits August 29, 2022 10:52

ENDO-536 review updates & misc

8b6ca1b

ENDOC-536 review edits and other updates

3faee94

Lyd1aCla1r3 reviewed Aug 29, 2022

View reviewed changes

ENDOC-536 Review edits & more

39e127f

jyunmitch commented Aug 29, 2022

View reviewed changes

ENDOC-536 final edits

6a5981d

Lyd1aCla1r3 approved these changes Aug 30, 2022

View reviewed changes

nshaw approved these changes Aug 31, 2022

View reviewed changes

jyunmitch merged commit 2080a0c into main Aug 31, 2022

jyunmitch deleted the ENDOC-536-version branch August 31, 2022 15:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENDOC-536 new bundle classification #555

ENDOC-536 new bundle classification #555

jyunmitch commented Aug 24, 2022 •

edited

Loading

nshaw Aug 25, 2022

jyunmitch Aug 25, 2022

Lyd1aCla1r3 Aug 25, 2022

jyunmitch Aug 25, 2022 •

edited

Loading

Lyd1aCla1r3 Aug 25, 2022

Lyd1aCla1r3 Aug 25, 2022

jyunmitch Aug 29, 2022

Lyd1aCla1r3 Aug 29, 2022

Lyd1aCla1r3 Aug 25, 2022

Lyd1aCla1r3 Aug 25, 2022

Lyd1aCla1r3 Aug 25, 2022

Lyd1aCla1r3 Aug 25, 2022

jyunmitch Aug 29, 2022

Lyd1aCla1r3 Aug 25, 2022

jyunmitch Aug 29, 2022

Lyd1aCla1r3 Aug 25, 2022

jyunmitch Aug 29, 2022

Lyd1aCla1r3 Aug 29, 2022

Lyd1aCla1r3 Aug 25, 2022

Lyd1aCla1r3 Aug 29, 2022

Lyd1aCla1r3 Aug 29, 2022

jyunmitch Aug 29, 2022

Lyd1aCla1r3 Aug 29, 2022

jyunmitch Aug 30, 2022

jyunmitch Aug 29, 2022

nshaw left a comment


		# Entando Bundle Transition to 7.1

		Entando 7.1 implements a more modular approach to building apps with the ent bundle CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based OCI bundles, and this page clarifies the differences between the two, along with the improvements that were made with the new release.

ENDOC-536 new bundle classification #555

ENDOC-536 new bundle classification #555

Conversation

jyunmitch commented Aug 24, 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 Aug 25, 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

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

nshaw left a comment

Choose a reason for hiding this comment

jyunmitch commented Aug 24, 2022 •

edited

Loading

jyunmitch Aug 25, 2022 •

edited

Loading