Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENDOC-527 note about Hub versions #615

Merged
merged 4 commits into from
Nov 3, 2022
Merged

ENDOC-527 note about Hub versions #615

merged 4 commits into from
Nov 3, 2022

Conversation

jyunmitch
Copy link
Collaborator

No description provided.

@@ -5,24 +5,30 @@ sidebarDepth: 2
# Entando Hub
## Overview

The Entando Hub enables a team to share components across Entando Applications. It can be installed in Entando 6.3.2 or higher and includes API-level integration with the Entando 7.0 App Builder.
The enterprise Entando Hub enables teams to share components across the organization and between Entando Applications. It can be installed in Entando 6.3.2 or higher and includes API-level integration with the Entando 7.0 App Builder.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence looks like it's only describing the enterprise Hub which is the third option below. I think the original sentence was better for a description of the Hub in general. Just my 2 cents.

* Entando Cloud Hub is the public catalog containing packaged business capabilities and components provided by Entando and its partners throughout the world.
* An enterprise Entando Hub, developed and curated by Entando clients and partners, can be used to share components within their organization or made available for public use.

This tutorial covers the steps for an enterprise Entando Hub:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have mixed feelings on "enterprise" here. I feel like the instructions are general purpose and since we don't have instructions for #1 (since it's baked in) or #2 (since it's ours), calling out #3 adds a little confusion.

@@ -5,7 +5,7 @@ sidebarDepth: 2
# Entando Hub
## Overview

The enterprise Entando Hub enables teams to share components across the organization and between Entando Applications. It can be installed in Entando 6.3.2 or higher and includes API-level integration with the Entando 7.0 App Builder.
The Entando Hub enables teams to share components across the organization and between Entando Applications. It can be installed in Entando 6.3.2 or higher and includes API-level integration with the Entando 7.0 App Builder.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"the organization" is unclarified; which org is this referring to? any org or one in particular? (i.e. "their" org vs "an" org)

@@ -28,7 +28,7 @@ This tutorial covers the steps for an enterprise Entando Hub:

## Installation

The Hub is installed using the Local Hub and two Entando Bundles. The first bundle contains the micro frontends and microservices while the second sets up the initial content and pages for the Hub user experience.
The Hub is installed using the Local Hub and two Entando Bundles. The first bundle contains the micro frontends and microservices while the second sets up the initial content and pages for the Hub user experience.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

experience -> interface; we can provide a consistent, tangible user interface, not user experience, i.e. focus on concrete details under our control

* The Local Hub, included in the Entando App Builder, displays a collection of components ready for use. These can be used to compose an application or as a starting point to create new components.
* Entando Cloud Hub is the public catalog containing packaged business capabilities and components provided by Entando and its partners throughout the world.
* An enterprise Entando Hub, developed and curated by Entando clients and partners, can be used to share components within their organization or made available for public use.
* The **Local Hub**, included in the Entando App Builder, displays a collection of components ready for use to compose an application or as a starting point to create new implementations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the grammar is a bit off here: collection of components...as a starting point -> collection of components...which comprise (just one example)

"ready for use" struck me as off so i googled -> ready to use. "ready-to-use" also shows up as a modifier, so "...components ready to use for application composition..." or "...ready-to-use components to compose..." (etc.)

"implementations" is a bit vague and imprecise; what you had previously is more accurate, where these components are the starting point to create new components, although i realize we want to avoid that repetition. i actually like what you had before (the 2 sentences, with ready for use -> ready to use) - simple and clear and correct

* An enterprise Entando Hub, developed and curated by Entando clients and partners, can be used to share components within their organization or made available for public use.
* The **Local Hub**, included in the Entando App Builder, displays a collection of components ready for use to compose an application or as a starting point to create new implementations.
* **Entando Cloud Hub** is the public catalog containing packaged business capabilities and components provided by Entando and its partners throughout the world.
* An **enterprise Entando Hub**, developed and curated by Entando clients and partners, can be used to share components within their organization or made available for public use.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"their" doesn't work here; clients and partners aren't part of a single organization -> "their respective organizations"

@jyunmitch jyunmitch merged commit 6b75b5a into main Nov 3, 2022
@jyunmitch jyunmitch deleted the ENDOC-527 branch November 3, 2022 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants