diff --git a/messages/bundle_create.md b/messages/bundle_create.md index 898b6587..68d998bc 100644 --- a/messages/bundle_create.md +++ b/messages/bundle_create.md @@ -10,7 +10,7 @@ A package bundle is an artifact composed of one or more 2GP managed packages. Wi - Create a package bundle in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com: -<%= config.bin %> <%= command.id %> --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 diff --git a/messages/bundle_install.md b/messages/bundle_install.md index 1ab380e7..267262ae 100644 --- a/messages/bundle_install.md +++ b/messages/bundle_install.md @@ -1,20 +1,20 @@ # 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, 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. +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 and wait 10 minutes for the installation to complete: - <%= config.bin %> <%= command.id %> --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --target-dev-hub devhub@example.com --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. The valid format is BundleName@VersionNumber, such as "MyPkgBundle@0.1". +Package bundle version to install. The valid format is BundleName@VersionNumber, such as "MyPkgBundle@0.1". # flags.target-org.summary @@ -26,7 +26,7 @@ Org ID of the Dev Hub org where the bundle was created. # flags.dev-hub-org.description -Enter the Dev Hub org ID, such as 00Dxx0000000000. +Enter the Dev Hub org ID, such as 00Dxx0000000000. # flags.wait.summary diff --git a/messages/bundle_install_list.md b/messages/bundle_install_list.md index 90efcb19..b7d9144b 100644 --- a/messages/bundle_install_list.md +++ b/messages/bundle_install_list.md @@ -12,7 +12,7 @@ To get information about a specific request, run "<%= config.bin %> package bund # flags.status.summary -Filter the list by the status of the installation request. Valid values are: Queued, Success, and Error. +Status of the installation request, used to filter the list. # flags.verbose.summary @@ -20,7 +20,7 @@ Display additional information, such as the validation text for each package bun # flags.created-last-days.summary -Filter the list by the number of days since the request was created, starting at 0. Use 0 for today. +Number of days since the request was created, starting at 0. Use 0 for today. # examples diff --git a/messages/bundle_install_report.md b/messages/bundle_install_report.md index d760b594..8aeaa70e 100644 --- a/messages/bundle_install_report.md +++ b/messages/bundle_install_report.md @@ -4,18 +4,14 @@ 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 ID of the package bundle installation request to report on. @@ -38,9 +34,9 @@ Development Organization # validation-error -Validation Error +Validation Error -# created-date +# created-date Created Date diff --git a/messages/bundle_list.md b/messages/bundle_list.md index 82f7c63f..95298408 100644 --- a/messages/bundle_list.md +++ b/messages/bundle_list.md @@ -6,11 +6,11 @@ List all package bundles in the Dev Hub org. - List all package bundles in the Dev Hub org with the username `devhub@example.com`: -`sf package bundle list --target-dev-hub devhub@example.com` + <%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com -# namespace +# namespace -Namespace Prefix +Namespace Prefix # name @@ -22,11 +22,11 @@ ID # bundle-id -Package Bundle ID +Package Bundle ID # alias -Alias +Alias # description @@ -34,7 +34,7 @@ Description # flags.verbose.summary -Display extended details about the package bundles. +Display extended details about the package bundles. # error-notification-username @@ -42,4 +42,4 @@ Error Notification Username # createdBy -Created By +Created By diff --git a/messages/bundle_version_create.md b/messages/bundle_version_create.md index bf26afd7..26c1c15c 100644 --- a/messages/bundle_version_create.md +++ b/messages/bundle_version_create.md @@ -4,17 +4,17 @@ Create a new package bundle version. # description -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. +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 package bundle version in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com: -<%= config.bin %> <%= command.id %> --bundle “Your bundle name” --definition-file resources/definition.json --target-dev-hub devhub@example.com + <%= config.bin %> <%= command.id %> --bundle “Your bundle name” --definition-file resources/definition.json --target-dev-hub devhub@example.com # flags.bundle.summary @@ -22,7 +22,7 @@ Name or ID of the package bundle to create a version for. # flags.definition-file.summary -Path to a definition file, similar to a scratch org definition file, that contains the list of package versions to include in the bundle. +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 diff --git a/messages/bundle_version_create_list.md b/messages/bundle_version_create_list.md index 5713b4ac..e350061f 100644 --- a/messages/bundle_version_create_list.md +++ b/messages/bundle_version_create_list.md @@ -12,7 +12,7 @@ To get information about a specific request, run "<%= config.bin %> package bund # flags.status.summary -Filter the list by the status of the bundle version creation request. Valid values are Queued, Success, or Error. +Status of the installation request, used to filter the list. # flags.show-conversions-only.summary @@ -24,7 +24,7 @@ Display additional information, such as the version name and number for each pac # flags.created-last-days.summary -Filter the list by the number of days since the request was created, starting at 0. Use 0 for today. +Number of days since the request was created, starting at 0. Use 0 for today. # examples diff --git a/messages/bundle_version_create_report.md b/messages/bundle_version_create_report.md index f65df862..cdf0949d 100644 --- a/messages/bundle_version_create_report.md +++ b/messages/bundle_version_create_report.md @@ -4,18 +4,14 @@ Report on the status of a package bundle version creation request. # description -Use this command to check the status of a package bundle version creation request. The command returns information about the request, including its current status and details about the package bundle version being created. +The command returns information such as the request's current status and details about the package bundle version being created. -# examples +# examples - Report on a package bundle version creation request: <%= config.bin %> <%= command.id %> --package-create-request-id 0Ho0x0000000000000 -- Report on a package bundle version creation request using an alias: - - <%= config.bin %> force:package:bundle:version:create:report -i 0Ho0x0000000000000 - # flags.bundle-version-create-request-id.summary ID of the package bundle version creation request to report on. @@ -36,11 +32,11 @@ Package Bundle ID Package Bundle Version ID -# version-name +# version-name Version Name -# created-date +# created-date Created Date diff --git a/messages/bundle_version_list.md b/messages/bundle_version_list.md index a4dbf6ee..585da22a 100644 --- a/messages/bundle_version_list.md +++ b/messages/bundle_version_list.md @@ -6,7 +6,7 @@ List all package bundle versions in the Dev Hub org. - List package bundle versions in the Dev Hub org with the username devhub@example.com: -<%= config.bin %> <%= command.id %> --bundle “Your bundle name or ID” --target-dev-hub devhub@example.com + <%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com # namespace @@ -15,7 +15,7 @@ Namespace Prefix # name Name - + # id ID @@ -34,7 +34,7 @@ Description # flags.verbose.summary -Display extended details about the package bundle versions. +Display extended details about the package bundle versions. # error-notification-username diff --git a/messages/bundle_version_report.md b/messages/bundle_version_report.md index 8ae31281..063d70f6 100644 --- a/messages/bundle_version_report.md +++ b/messages/bundle_version_report.md @@ -6,7 +6,7 @@ Retrieve details about a specific package bundle version. - Retrieve details about the package bundle version; uses the Dev Hub org with the username devhub@example.com: -<%= config.bin %> <%= command.id %> --bundle-version "Your bundle version name or ID" --target-dev-hub devhub@example.com + <%= config.bin %> <%= command.id %> --bundle-version "Your bundle version name or ID" --target-dev-hub devhub@example.com # flags.bundle-version.summary