ENDOC-609 remove quarkus and edit #634

jyunmitch · 2022-11-30T00:17:17Z

No description provided.

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

vuepress/docs/next/docs/reference/deployment-structure.md

Lyd1aCla1r3 · 2022-12-06T01:51:15Z

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

 * Caching implementation
-  * When generating a microservice you will be presented with the type of cache to inject into the services. It is recommended that this is a standard choice for all of the microservices in your application but can be customized on a per service basis if desired.
+  * When generating a microservice, you will be presented with the type of cache to inject into the services. It is recommended that the type be uniform for all the microservices in your application, but it can be customized on a per service basis if desired.


"you will presented with the type of cache" makes it seem like the choice was made for you, but really you're given a choice. "...presented with a choice for the type of cache..." or something similar for this to be accurate and the rest of the paragraph to make sense.

since "per service" is an adjective it should be hyphenated

"all microservices" or "all of the microservices"... "all the microservices" seems like it's missing the "of"

"the type be uniform" is synonymous with "uniform type" and this implies something about the type characteristics, not how it is used. "...the type is consistent across/for all microservices..."

edited

hyphenated

edited

it is referring to uniform type of cache, not how it is used. Edited

Lyd1aCla1r3 · 2022-12-06T01:52:25Z

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

 * Build system
-  * Determines the java build tool to use when building your services
-  * Supports maven or gradle
+  * Determines the Java build tool to use when building your services


"Java build tool" is a kind of overkill, given the bullet header and "when building your services"; it also is a bit of a mouthful

it adds a specificity to the type of tool so left as is. It is repetitive but thought necessary

Lyd1aCla1r3 · 2022-12-06T01:56:45Z

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

 * Other technologies
-  * Users of the component generator can also decide to use other technologies from JHipster or from the JHipster marketplace.
-  * There are many powerful technologies in the marketplace but it is up to the developer to integrate any choices from the marketplace into their Entando application. Entando doesn't provide any direct support for marketplace tech choices.
+  * Users of the component generator can also decide to use other technologies from JHipster or the JHipster marketplace.


i think we're capitalizing this just like the Component Manager - so Entando Component Generator or Component Generator (it's a propriety thing, not a common industry term)

"...other technologies offered/supported by JHipster" or "other JHipster technologies" is clearer - otherwise there's the question of the difference between JHipster technologies and what's in the JHipster marketplace; what is another technology from JHipster besides what's found in the marketplace?? that needs to be clarified to keep the current wording.

capitalized

the JHipster marketplace is a specific thing, and it is not capitalized on their site. These are third party tech so you can use other technologies from JHipster

Lyd1aCla1r3 · 2022-12-06T02:01:14Z

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

-  * Users of the component generator can also decide to use other technologies from JHipster or from the JHipster marketplace.
-  * There are many powerful technologies in the marketplace but it is up to the developer to integrate any choices from the marketplace into their Entando application. Entando doesn't provide any direct support for marketplace tech choices.
+  * Users of the component generator can also decide to use other technologies from JHipster or the JHipster marketplace.
+  * There are many powerful technologies in the marketplace but it is up to the developer to integrate the chosen technology into their Entando application. Entando doesn't provide direct support for marketplace tech choices.


their chosen technology

Entando Application

marketplace tech choices -> marketplace selections. the current wording seems too casual

too many theirs

capitalized

tech is used in all kids of contexts, think it's fine here

Lyd1aCla1r3 · 2022-12-06T02:02:25Z

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

 * Micro frontends
-  * Users can optionally choose to generate micro frontends for entities generated via the blueprint.
+  * Optionally, users can choose to generate micro frontends for entities generated via the blueprint.


...i thought the MFEs were the entities that were optionally generated? @nshaw? shouldn't this read "for microservices"?

the entity is conference, isn't it?

Line 22 is good as-is per conversation.

Lyd1aCla1r3 · 2022-12-06T02:06:32Z

vuepress/docs/next/docs/reference/deployment-structure.md

@@ -51,37 +50,35 @@ A customized image can include:
 * New APIs 
 * Legacy Entando plugins
 * New database tables  
-* Other extensions to the **entando-core** 
+* Other extensions to the entando-core


why isn't the entando-core getting love anymore?? if we're bolding entando-de-app shouldn't its counterpart get the same treatment? (applies to above instance as well)

Ok, the bolding on this page drove me crazy and I went back and forth on it numerous times. So I decided to bold just the main item in each section. Considered backticking but then backticking App Builder seemed weird. Spending way too much time on bolding vs. backticking ... then do I highlight operator and other such mentions, so just kept header item bolded and other objects backticked in sections not their own. Guess I can backtick entando-core though.

i personally avoid bolding and only use backtracking for commands or (not always) the names of software functions/objects/tools, etc.

Lyd1aCla1r3 · 2022-12-06T02:07:36Z

vuepress/docs/next/docs/reference/deployment-structure.md


-It is recommended that most extensions to the Entando Platform occur in microservices. However, legacy 
+It is recommended that microservices are used for most extensions to the Entando Platform. However, legacy 


this should be tightened up to clarify whether the extension IS a MS or if an extension facilitates an MS

it's neither, it's just saying to use ms to extend the platform

Lyd1aCla1r3 · 2022-12-06T02:08:50Z

vuepress/docs/next/docs/reference/deployment-structure.md

-The ECM also manages relationships between an Entando Application and the 
-installed plugins. This can be seen in the plugin link custom resource in Kubernetes. 
+The Component Manager also administers the relationships between an Entando Application and the 
+installed plugins. This is seen in the plugin link custom resource in Kubernetes. 


"plugin link custom resource" is so many modifiers... "custom resource for the plugin link"

Lyd1aCla1r3 · 2022-12-06T02:17:18Z

vuepress/docs/next/docs/reference/deployment-structure.md

@@ -99,16 +96,15 @@ The Keycloak image can be customized as part of an Entando implementation. Some

 ## Other Key Repositories 
 ### entando-core
-The **entando-core** project is a J2EE application that exposes APIs for the Entando CMS, including the admin console and the portal UI project that performs the server side composition for pages rendered via an Entando Application. Note that only the composition is performed server side. JavaScript code is rendered client-side. The **entando-core** is realized via an instance that includes the 
-WAR files generated from a core build as dependencies. In a default deployment, this is the **entando-de-app**.
+The **entando-core** project is a J2EE application that exposes APIs for the Entando CMS, including the admin console and the portal UI project that performs the server-side composition for pages rendered via an Entando Application. Note that only the composition is performed server-side. JavaScript code is rendered client-side. The entando-core is realized via an instance that includes the WAR files as dependencies, which are generated from the core build. In a default deployment, this is the `entando-de-app`.


@nshaw is this still accurate? i feel like the admin console (lowercase??) and portal UI (i know should be Portal UI...) were intentionally omitted from the glossary??

Accurate but good to uppercase Admin Console and Portal UI

Lyd1aCla1r3 · 2022-12-06T02:19:15Z

vuepress/docs/v7.1/docs/create/component-gen-tech.md

@@ -3,8 +3,7 @@
 When generating a microservice using the Entando Component Generator there are a number of technical choices that need to be made

 * Microservice code
-  * 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#microservices-specifications), including information on the runtime contract required to use them. 
+  * If you're considering non-Java based microservices, here are the [specifications of an Entando microservice](../curate/bundle-details.md#microservices-specifications), including information on the runtime contract required to use them. 


sooo... it should be Java-based with a hyphen, and the negative of that in the form non-Java-based is a definite no... "microservices that aren't java-based" to avoid this?

Lyd1aCla1r3 · 2022-12-06T21:28:48Z

vuepress/docs/next/docs/reference/deployment-structure.md


 * GitHub: <https://github.com/entando-k8s/entando-k8s-controller-coordinator/>
 * DockerHub: <https://hub.docker.com/repository/docker/entando/entando-k8s-controller-coordinator>

 #### Customization
-Use the [Entando Custom Resources](../consume/custom-resources.md) to extend the Platform.
+Use the [Entando custom resources](../consume/custom-resources.md) to extend the Platform.


platform lowercase

that actually doesn't make sense because everything else with entando in front remains capitalized

no. the platform and operator are the exceptions, because those are general terms. the Component Manager and Component Generator are capitalized because these are entando-specific terms. the decision on platform/operator was made months ago and transferred to our glossary spreadsheet. it may also be in the team notes somewhere.

also Entando Component / component, Entando Plugin / plugin, Entando Content / content, Entando Page / page... it's actually a pretty extensive list

ENDOC-609 remove quarkus and edit

b5fe6b2

jyunmitch requested review from nshaw and Lyd1aCla1r3 November 30, 2022 00:17

nshaw reviewed Dec 1, 2022

View reviewed changes

vuepress/docs/next/docs/create/component-gen-tech.md Outdated Show resolved Hide resolved

vuepress/docs/next/docs/reference/deployment-structure.md Outdated Show resolved Hide resolved

vuepress/docs/next/docs/reference/deployment-structure.md Outdated Show resolved Hide resolved

Lyd1aCla1r3 reviewed Dec 1, 2022

View reviewed changes

jyunmitch added 2 commits December 2, 2022 10:16

ENDOC-609 review edits

4bfa2fc

ENDOC-609 more edits

8c4dd2e

Lyd1aCla1r3 reviewed Dec 6, 2022

View reviewed changes

ENDOC-609 more review edits

24c42e2

Lyd1aCla1r3 reviewed Dec 6, 2022

View reviewed changes

ENDOC-609 final review edit

3575e07

Lyd1aCla1r3 approved these changes Dec 9, 2022

View reviewed changes

jyunmitch merged commit 2bf15d5 into main Dec 12, 2022

jyunmitch deleted the ENDOC-609 branch December 12, 2022 14:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENDOC-609 remove quarkus and edit #634

ENDOC-609 remove quarkus and edit #634

jyunmitch commented Nov 30, 2022

Lyd1aCla1r3 Dec 6, 2022

jyunmitch Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022

jyunmitch Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022

jyunmitch Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022

jyunmitch Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022

jyunmitch Dec 6, 2022

nshaw Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022

jyunmitch Dec 6, 2022

jyunmitch Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022

jyunmitch Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022

nshaw Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022

jyunmitch Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022

Lyd1aCla1r3 Dec 6, 2022


		It is recommended that most extensions to the Entando Platform occur in microservices. However, legacy
		It is recommended that microservices are used for most extensions to the Entando Platform. However, legacy

ENDOC-609 remove quarkus and edit #634

ENDOC-609 remove quarkus and edit #634

Conversation

jyunmitch commented Nov 30, 2022

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment