Merge pull request #1095 from salesforcecli/j-nolasco-edit-package-bundle-messages

W-20511663: Update help text for package bundle commands and flags

Author: btrn11

messages/bundle_create.md

@@ -1,17 +1,16 @@
 # summary
 
-Create a package bundle in the Dev Hub org.
+Create a package bundle in the Dev Hub org. 
 
 # description
 
-A package bundle is an artifact that contains one or more 2GP managed packages.
-A bundle can be installed or upgraded as a single artifact.
+A package bundle is an artifact composed of one or more 2GP managed packages. With a package bundle, you can develop, install, upgrade, and manage multiple packages as a single unit.
 
 # examples
 
-Create a package bundle in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
+- Create a package bundle in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
 
-sf package bundle create --name "Your bundle name" --description "Your bundle description" --target-dev-hub devhub@example.com
+  <%= config.bin %> <%= command.id %> --name "Your bundle name" --description "Your bundle description" --target-dev-hub devhub@example.com
 
 # flags.name.summary
 
@@ -23,11 +22,11 @@ Description of the package bundle.
 
 # flags.wait.summary
 
-Number of minutes to wait for the bundle creation to complete.
+Number of minutes to wait for the package bundle to be created.
 
 # flags.verbose.summary
 
-Display extended bundle creation detail.
+Display extended details about the package bundle creation.
 
 # requestInProgress
 

messages/bundle_install.md

@@ -1,48 +1,44 @@
 # summary
 
-Install a package bundle version in the target org.
+Install a specific version of a package bundle in the target org.
 
 # description
 
-Install a specific version of a package bundle in the target org. During developer preview, bundles can be installed only in scratch orgs.
+During developer preview, package bundles can be installed only in scratch orgs. To install a package bundle in a scratch org, add the PackageBundles feature to the scratch org definition file.
 
-# examples
+# examples 
 
-- Install a package bundle version in a scratch org:
+- Install a package bundle version in a scratch org and wait 10 minutes for the installation to complete:
 
-  <%= config.bin %> <%= command.id %> --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --dev-hub-org 00Dxx0000000000 --wait 10
-
-- Install using a bundle version ID:
-
-  <%= config.bin %> <%= command.id %> --bundle 1Q8Wt0000000q1pKAA --target-org my-scratch-org --dev-hub-org 00Dxx0000000000 --wait 10
+  <%= config.bin %> <%= command.id %> --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --dev-hub-org devhub@example.com --wait 10
 
 # flags.bundle.summary
 
-Package bundle version to install (format: BundleName@Version or bundle version ID).
+Package bundle version to install. The valid format is BundleName@VersionNumber, such as "MyPkgBundle@0.1".
 
 # flags.target-org.summary
 
-Target org for the bundle installation.
+Username or alias of the org in which to install the package bundle version. Not required if the `target-org` configuration variable is already set.
 
 # flags.dev-hub-org.summary
 
 Org ID of the Dev Hub org where the bundle was created.
 
 # flags.dev-hub-org.description
 
-Specify the Dev Hub org ID directly (such as 00Dxx0000000000). 
+Enter the Dev Hub org ID, such as 00Dxx0000000000.
 
 # flags.wait.summary
 
 Number of minutes to wait for the installation to complete.
 
 # flags.verbose.summary
 
-Display extended installation detail.
+Display extended details about the installation.
 
 # requestInProgress
 
-Installing bundle.
+Installing package bundle.
 
 # bundleInstallWaitingStatus
 

messages/bundle_install_list.md

@@ -8,19 +8,19 @@ Shows the details of each request to install a package bundle version in the tar
 
 All filter parameters are applied using the AND logical operator (not OR).
 
-To get information about a specific request, run "<%= config.bin %> package bundle install report" and supply the request ID.
+To get information about a specific request, run "<%= config.bin %> package bundle install report" and enter the request ID.
 
 # flags.status.summary
 
 Status of the installation request, used to filter the list.
 
 # flags.verbose.summary
 
-Displays additional information at a slight performance cost, such as validation text for each package bundle install request.
+Display additional information, such as the validation text for each package bundle installation request.
 
 # flags.created-last-days.summary
 
-Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.
+Number of days since the request was created, starting at 0. Use 0 for today.
 
 # examples
 
@@ -30,17 +30,17 @@ Number of days since the request was created, starting at 00:00:00 of first day
 
 - List package bundle installation requests from the last 3 days in the Dev Hub org with username devhub@example.com:
 
-  <%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub
+  <%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub devhub@example.com
 
-- List package bundle installation requests with status Error:
+- List package bundle installation requests with the Error status:
 
   <%= config.bin %> <%= command.id %> --status Error
 
-- List package bundle installation requests with status Queued:
+- List package bundle installation requests with the Queued status:
 
   <%= config.bin %> <%= command.id %> --status Queued
 
-- List package bundle installation requests with status Success that were created today:
+- List package bundle install requests from today with the Success status:
 
   <%= config.bin %> <%= command.id %> --created-last-days 0 --status Success
 

messages/bundle_install_report.md

@@ -4,21 +4,17 @@ Report on the status of a package bundle installation request.
 
 # description
 
-Use this command to check the status of a package bundle installation request. The command returns information about the request, including its current status and details about the package bundle version being installed.
+The command returns information such as the current status of the request and details about the package bundle version being installed.
 
-# examples
+# examples 
 
 - Report on a package bundle installation request:
 
   <%= config.bin %> <%= command.id %> --package-install-request-id 0Ho0x0000000000000
 
-- Report on a package bundle installation request using an alias:
-
-  <%= config.bin %> force:package:bundle:install:report -i 0Ho0x0000000000000
-
 # flags.package-install-request-id.summary
 
-The ID of the package bundle installation request to report on.
+ID of the package bundle installation request to report on.
 
 # id
 
@@ -38,9 +34,9 @@ Development Organization
 
 # validation-error
 
-Validation Error
+Validation Error 
 
-# created-date
+# created-date 
 
 Created Date
 

messages/bundle_list.md

@@ -4,42 +4,42 @@ List all package bundles in the Dev Hub org.
 
 # examples
 
-List all package bundles in the specified Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
+- List all package bundles in the Dev Hub org with the username `devhub@example.com`:
 
-sf package bundle list --target-dev-hub <dev_hub_alias>
+  <%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com
 
-# namespace
+# namespace 
 
-Namespace Prefix
+Namespace Prefix 
 
 # name
 
 Name
 
 # id
 
-Id
+ID
 
 # bundle-id
 
-Package Bundle Id
+Package Bundle ID 
 
 # alias
 
-Alias
+Alias 
 
 # description
 
 Description
 
 # flags.verbose.summary
 
-Display extended bundle detail.
+Display extended details about the package bundles.
 
 # error-notification-username
 
 Error Notification Username
 
 # createdBy
 
-Created By
+Created By 

messages/bundle_version_create.md

@@ -4,25 +4,29 @@ Create a new package bundle version.
 
 # description
 
-Create a new version of a package bundle with the specified components.
+Before you create a new bundle version, create a definition file (similar to a scratch org definition file) that contains the list of package versions to include in the bundle. The definition file must be JSON and you must specify the package versions in the correct order of installation. The package bundle version is based on package versions listed in the definition file.
 
+After the first bundle version that you create, make sure to update the version number in the sfdx-project.json file for subsequent bundle versions.
+
+To retrieve details about a package bundle version create request, including status and package bundle version ID (04t), run "sf package version create report -i 08c...".
+  
 # examples
 
-Create a new version of a package bundle:
+- Create a package bundle version in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
 
-sf package bundle version create -b MyBundle -p path/to/definition.json
+  <%= config.bin %> <%= command.id %> --bundle “Your bundle name” --definition-file resources/definition.json --target-dev-hub devhub@example.com
 
 # flags.bundle.summary
 
-The name or ID of the package bundle to create a version for.
+Name or ID of the package bundle to create a version for.
 
 # flags.definition-file.summary
 
-Path to the JSON file containing the list of components to include in the bundle version.
+Path to a definition file, similar to a scratch org definition file, that contains the list of package versions to include in the bundle.
 
 # flags.wait.summary
 
-Number of minutes to wait for the command to complete before timing out.
+Number of minutes to wait for the package bundle version to be created.
 
 # flags.verbose.summary
 
@@ -46,29 +50,29 @@ Waiting for bundle version creation to complete. %s minutes remaining. Current s
 
 # bundleVersionCreateFinalStatus
 
-Package Bundle version creation completed with status: %s
+Package bundle version creation completed with status: %s
 
 # multipleErrors
 
-The following errors occurred during bundle version creation:
+The following errors occurred during package bundle version creation:
 %s
 
 # InProgress
 
-Bundle version creation is %s. Use 'sf package bundle version create report -i %s' to check the status later.
+Package bundle version creation is %s. Use "sf package bundle version create report -i %s" to check the status later.
 
 # requestInProgress
 
-Creating bundle version...
+Creating package bundle version...
 
 # packageVersionCreateFinalStatus
 
-Package Bundle version creation completed with status: %s
+Package bundle version creation completed with status: %s
 
 # packageVersionCreatePerformingValidations
 
 Performing validations on the package bundle version...
 
 # bundleVersionCreateSuccess
 
-Successfully created bundle version for bundle %s
+Successfully created package bundle version for bundle %s

messages/bundle_version_create_list.md

@@ -8,43 +8,43 @@ Shows the details of each request to create a package bundle version in the Dev
 
 All filter parameters are applied using the AND logical operator (not OR).
 
-To get information about a specific request, run "<%= config.bin %> package bundle version create report" and supply the request ID.
+To get information about a specific request, run "<%= config.bin %> package bundle version create report" and enter the request ID.
 
 # flags.status.summary
 
-Status of the version creation request, used to filter the list.
+Status of the installation request, used to filter the list.
 
 # flags.show-conversions-only.summary
 
-Filter the list output to display only converted package bundle version.
+Filter the list to display only converted package bundle versions.
 
 # flags.verbose.summary
 
-Displays additional information at a slight performance cost, such as the version name and number for each package version create request.
+Display additional information, such as the version name and number for each package bundle version creation request.
 
 # flags.created-last-days.summary
 
-Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.
+Number of days since the request was created, starting at 0. Use 0 for today.
 
 # examples
 
 - List all package bundle version creation requests in your default Dev Hub org:
 
   <%= config.bin %> <%= command.id %>
 
-- List package bundle version creation requests from the last 3 days in the Dev Hub org with username devhub@example.com:
+- List package bundle version creation requests from the last three days in the Dev Hub org with the username devhub@example.com:
 
-  <%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub
+  <%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub devhub@example.com
 
-- List package bundle version creation requests with status Error:
+- List package bundle version creation requests with the Error status:
 
   <%= config.bin %> <%= command.id %> --status Error
 
-- List package bundle version creation requests with status Queued:
+- List package bundle version creation requests with the Queued status:
 
   <%= config.bin %> <%= command.id %> --status Queued
 
-- List package bundle version creation requests with status Success that were created today:
+- List package bundle version creation requests from today with the Success status:
 
   <%= config.bin %> <%= command.id %> --created-last-days 0 --status Success
 
@@ -58,16 +58,16 @@ Status
 
 # package-id
 
-Package Bundle Id
+Package Bundle ID
 
 # packageVersionId
 
-Package Bundle Version Id
+Package Bundle Version ID
 
 # createdBy
 
 Created By
 
 # convertedFromVersionId
 
-Converted From Version Id
+Converted From Version ID