Merge pull request #780 from entando/ENDOC-752-privatehub-api

ENDOC-752-privatehub-api
entando · Nov 7, 2023 · cb38501 · cb38501
2 parents f1757a4 + bfcbfdd
commit cb38501
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 3 deletions.
diff --git a/vuepress/docs/next/docs/getting-started/ent-bundle.md b/vuepress/docs/next/docs/getting-started/ent-bundle.md
@@ -55,14 +55,17 @@ See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-si
 |:--|:--
 |`ent bundle init [name]` | Initialize a new empty project with the default structure and files |
 |`ent bundle init [name] --from-hub`| Initialize a bundle from the Entando Cloud Hub |
-|`ent bundle init [name] --from-hub --hub-url=[url]` | Initialize a bundle from a custom Entando Hub |
+|`ent bundle init [name] --from-hub --hub-url=[url]` | Initialize a bundle from an enterprise Entando Hub |
+|`ent bundle init [name] --from-hub --hub-url=[url] --hub-api-key=[]` | Initialize a bundle from a private Entando Hub with an API key|
 
 #### Init Command Details
 - Bundle names may only contain lowercase letters, numbers, periods(.) and dashes(-). They cannot start or end with periods or dashes.
-- `--from-hub`: This option leverages an existing bundle from an Entando Hub to jumpstart your project. The ent bundle tool will pull the package and rebuild the structure, after which it can be customized locally.
+- `--from-hub`: This option leverages an existing bundle from an Entando Hub to jumpstart your project. The `ent bundle` tool will pull the package and rebuild the structure, which can then be customized locally.
 
 - `--hub-url`: Use this option to specify a custom Entando Hub, else ent defaults to the Entando Cloud Hub
 
+- `--hub-api-key`: This flag supplies the [Hub API key](../../tutorials/solution/entando-hub.md#create-a-private-catalog) to access a bundle from a private enterprise Entando Hub to copy it locally. 
+
 ### Micro Frontend and Microservice
 | Command| Descriptions
 |:--|:--

diff --git a/vuepress/docs/next/tutorials/solution/entando-hub.md b/vuepress/docs/next/tutorials/solution/entando-hub.md
@@ -118,6 +118,8 @@ API access to private catalogs requires the use of an API key instead of user cr
 2. From the Hub UI homepage, click on the gear icon right of the `Add +` button and select `API Key Management`.
 3. Click `Generate API Key`, enter a name, and confirm with the blue generate button. Save the key for future reference.
 
+The API key is required to access the bundles and PBCs in a private Entando Hub catalog. Bundles can be initialized directly from there using the [ent bundle init command](../../docs/getting-started/ent-bundle.md#initialization) or by adding the registry in your App Builder and deploying it from that catalog as described below. 
+
 ### Add a Catalog as a Registry in your App Builder
 Any enterprise Hub instance can be accessed from the Entando App Builder of another Entando Application. 
 

diff --git a/vuepress/docs/v7.3/docs/getting-started/ent-bundle.md b/vuepress/docs/v7.3/docs/getting-started/ent-bundle.md
@@ -56,13 +56,16 @@ See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-si
 |`ent bundle init [name]` | Initialize a new empty project with the default structure and files |
 |`ent bundle init [name] --from-hub`| Initialize a bundle from the Entando Cloud Hub |
 |`ent bundle init [name] --from-hub --hub-url=[url]` | Initialize a bundle from a custom Entando Hub |
+|`ent bundle init [name] --from-hub --hub-url=[url] --hub-api-key=[]` | Initialize a bundle from a private Entando Hub with an API key|
 
 #### Init Command Details
 - Bundle names may only contain lowercase letters, numbers, periods(.) and dashes(-). They cannot start or end with periods or dashes.
-- `--from-hub`: This option leverages an existing bundle from an Entando Hub to jumpstart your project. The ent bundle tool will pull the package and rebuild the structure, after which it can be customized locally.
+- `--from-hub`: This option leverages an existing bundle from an Entando Hub to jumpstart your project. The `ent bundle` tool will pull the package and rebuild the structure, which can then be customized locally.
 
 - `--hub-url`: Use this option to specify a custom Entando Hub, else ent defaults to the Entando Cloud Hub
 
+- `--hub-api-key`: This flag supplies the [Hub API key](../../tutorials/solution/entando-hub.md#create-a-private-catalog) to access a bundle from a private enterprise Entando Hub to copy it locally. 
+
 ### Micro Frontend and Microservice
 | Command| Descriptions
 |:--|:--

diff --git a/vuepress/docs/v7.3/tutorials/solution/entando-hub.md b/vuepress/docs/v7.3/tutorials/solution/entando-hub.md
@@ -118,6 +118,8 @@ API access to private catalogs requires the use of an API key instead of user cr
 2. From the Hub UI homepage, click on the gear icon right of the `Add +` button and select `API Key Management`.
 3. Click `Generate API Key`, enter a name, and confirm with the blue generate button. Save the key for future reference.
 
+The API key is required to access the bundles and PBCs in a private Entando Hub catalog. Bundles can be initialized directly from there using the [ent bundle init command](../../docs/getting-started/ent-bundle.md#initialization) or by adding the registry in your App Builder and deploying it from that catalog as described below.
+
 ### Add a Catalog as a Registry in your App Builder
 Any enterprise Hub instance can be accessed from the Entando App Builder of another Entando Application.