Skip to content

Commit

Permalink
ENDOC-522 review edits
Browse files Browse the repository at this point in the history
  • Loading branch information
jyunmitch committed Aug 15, 2022
1 parent 4987c57 commit 6c42a44
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions vuepress/docs/next/docs/getting-started/ent-bundle.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebarDepth: 2
# Bundle Management - ent bundle CLI
The Entando Bundle CLI extends the functionality of **ent** with a modular bundle management system. Starting with Entando 7.1, `ent bundle` orchestrates the lifecycle of a project, packaging it into convenient recognizable bundles that can be inserted into any Entando Application. This composable approach takes advantage of a single project descriptor and repository, along with centralized [API management](ent-api.md) and [DB and Keycloak services](ent-svc.md).

This document covers `ent bundle` operations and the commands required to bundle a project.
This document covers `ent bundle` operations and the steps required to create an Entando Bundle.

1. [Initialization](#initialization)
2. [Build](#build)
Expand Down Expand Up @@ -36,8 +36,8 @@ See [Build and Publish a Project Bundle](../../tutorials/create/pb/publish-proje
|`ent bundle init`||Initialize project folder structure and descriptor
|`ent bundle list`|| List the available components in the bundle
|`ent bundle mfe` | `add` | Add an MFE project component
| | `rm` | Remove MFE project component
|`ent bundle ms`|`add`| Add MS project components
| | `rm` | Remove an MFE project component
|`ent bundle ms`|`add`| Add an MS project component
| | `rm` | Remove an MS project component
|`ent bundle run`|| Run bundle components
|`ent bundle pack`||Create distribution artifacts (Docker images)
Expand Down Expand Up @@ -65,7 +65,7 @@ See [Build and Publish a Project Bundle](../../tutorials/create/pb/publish-proje
|`ent bundle build --all-mfe`|Build all the micro frontends|

#### Command Details
`ent bundle build`: Constructs the project files based on the `entando.json` provided. It executes according to the type of stack your components are built with. For instance, a React MFE starts an npm build process. A `build` log file is generated for each component inside the .entando/logs directory for your project.
`ent bundle build`: Constructs the project files based on the provided `entando.json`. It executes according to the type of stack your components are built with. For instance, a React MFE starts an npm build process. A `build` log file is generated for each component inside the .entando/logs directory for your project.

## Run
| Command| Descriptions
Expand Down Expand Up @@ -107,8 +107,8 @@ Entando provides a series of `ent ecr` commands for managing bundle interactions
|`ent ecr gen-secret`| Generate and display a plugin Secret skeleton|
|`ent ecr generate-cr`|Generate the custom resource |
|`ent ecr get-bundle-id [repository-url]` | Calculate and display the bundle ID
|`ent ecr get-plugin-code --auto --repo=[repository-url]` |Calculate and display the plugin code for a Git-based v1 bundle|
|`ent ecr get-plugin-code [component-name] --repo=[repository-url]` | Calculate and display the plugin code for a Docker-based v5 bundle
|`ent ecr get-plugin-code --auto --repo=[repository-url]` |Calculate and display the plugin code for a Git-based bundle|
|`ent ecr get-plugin-code [component-name] --repo=[repository-url]` | Calculate and display the plugin code for a Docker-based bundle
|`ent ecr install`| Install a bundle to the ECR|
|`ent ecr install --conflict-strategy=OVERRIDE`|Adopt a strategy for conflicts on installed bundles|
|`ent ecr list`| Display the list of bundles associated with the current profile|
Expand Down
4 changes: 2 additions & 2 deletions vuepress/docs/next/docs/getting-started/ent-diag.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Diagnostic information is critical to analysis and troubleshooting, and the Enta
|`ent bundle info`|Show status information for the bundle project|
|`ent --debug bundle "command"` |Enable debug mode|
| `ent diag` | Run diagnostics on the pods currently in an Entando namespace and prepare a diagnostic tar.gz
| `ent pod-info` | Display `kubectl describe` and `kubectl logs` for each Entando pod in a namespace
| `ent pod-info` | Display the output of `kubectl describe` and `kubectl logs` for each Entando pod in a namespace
| `ent pod grep --all "error\|fail"` | Locate error messages within EntandoApp pods


Expand All @@ -24,5 +24,5 @@ Diagnostic information is critical to analysis and troubleshooting, and the Enta
```

### Log Files
* Log files for the bundle build and pack commands are generated for each component inside the .entando/logs directory. For a single component, it is printed to the standard output. Run command logs are also printed to the standard output.
* Log files for the bundle build and pack commands are generated for each component inside the .entando/logs directory. For a single component, the log is printed to the stdout. Run command logs are also printed to the standard output.

0 comments on commit 6c42a44

Please sign in to comment.