Skip to content

Commit aafee20

Browse files
authored
Merge pull request #1096 from salesforcecli/jshackell-sfdc-patch-1
Edit of Joanna's edits
2 parents 6c1b757 + da0daf9 commit aafee20

10 files changed

Lines changed: 34 additions & 42 deletions

messages/bundle_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A package bundle is an artifact composed of one or more 2GP managed packages. Wi
1010

1111
- Create a package bundle in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
1212

13-
<%= config.bin %> <%= command.id %> --name "Your bundle name" --description "Your bundle description" --target-dev-hub devhub@example.com
13+
<%= config.bin %> <%= command.id %> --name "Your bundle name" --description "Your bundle description" --target-dev-hub devhub@example.com
1414

1515
# flags.name.summary
1616

messages/bundle_install.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# summary
22

3-
Install a package bundle version in the target org.
3+
Install a specific version of a package bundle in the target org.
44

55
# description
66

7-
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.
7+
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.
88

9-
# examples
9+
# examples
1010

1111
- Install a package bundle version in a scratch org and wait 10 minutes for the installation to complete:
1212

13-
<%= config.bin %> <%= command.id %> --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --target-dev-hub devhub@example.com --wait 10
13+
<%= config.bin %> <%= command.id %> --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --dev-hub-org devhub@example.com --wait 10
1414

1515
# flags.bundle.summary
1616

17-
Package bundle version to install. The valid format is BundleName@VersionNumber, such as "MyPkgBundle@0.1".
17+
Package bundle version to install. The valid format is BundleName@VersionNumber, such as "MyPkgBundle@0.1".
1818

1919
# flags.target-org.summary
2020

@@ -26,7 +26,7 @@ Org ID of the Dev Hub org where the bundle was created.
2626

2727
# flags.dev-hub-org.description
2828

29-
Enter the Dev Hub org ID, such as 00Dxx0000000000.
29+
Enter the Dev Hub org ID, such as 00Dxx0000000000.
3030

3131
# flags.wait.summary
3232

messages/bundle_install_list.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ To get information about a specific request, run "<%= config.bin %> package bund
1212

1313
# flags.status.summary
1414

15-
Filter the list by the status of the installation request. Valid values are: Queued, Success, and Error.
15+
Status of the installation request, used to filter the list.
1616

1717
# flags.verbose.summary
1818

1919
Display additional information, such as the validation text for each package bundle installation request.
2020

2121
# flags.created-last-days.summary
2222

23-
Filter the list by the number of days since the request was created, starting at 0. Use 0 for today.
23+
Number of days since the request was created, starting at 0. Use 0 for today.
2424

2525
# examples
2626

messages/bundle_install_report.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,14 @@ Report on the status of a package bundle installation request.
44

55
# description
66

7-
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.
7+
The command returns information such as the current status of the request and details about the package bundle version being installed.
88

9-
# examples
9+
# examples
1010

1111
- Report on a package bundle installation request:
1212

1313
<%= config.bin %> <%= command.id %> --package-install-request-id 0Ho0x0000000000000
1414

15-
- Report on a package bundle installation request using an alias:
16-
17-
<%= config.bin %> force:package:bundle:install:report -i 0Ho0x0000000000000
18-
1915
# flags.package-install-request-id.summary
2016

2117
ID of the package bundle installation request to report on.
@@ -38,9 +34,9 @@ Development Organization
3834

3935
# validation-error
4036

41-
Validation Error
37+
Validation Error
4238

43-
# created-date
39+
# created-date
4440

4541
Created Date
4642

messages/bundle_list.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ List all package bundles in the Dev Hub org.
66

77
- List all package bundles in the Dev Hub org with the username `devhub@example.com`:
88

9-
`sf package bundle list --target-dev-hub devhub@example.com`
9+
<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com
1010

11-
# namespace
11+
# namespace
1212

13-
Namespace Prefix
13+
Namespace Prefix
1414

1515
# name
1616

@@ -22,24 +22,24 @@ ID
2222

2323
# bundle-id
2424

25-
Package Bundle ID
25+
Package Bundle ID
2626

2727
# alias
2828

29-
Alias
29+
Alias
3030

3131
# description
3232

3333
Description
3434

3535
# flags.verbose.summary
3636

37-
Display extended details about the package bundles.
37+
Display extended details about the package bundles.
3838

3939
# error-notification-username
4040

4141
Error Notification Username
4242

4343
# createdBy
4444

45-
Created By
45+
Created By

messages/bundle_version_create.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@ Create a new package bundle version.
44

55
# description
66

7-
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.
7+
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.
88

99
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.
1010

1111
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...".
12-
12+
1313
# examples
1414

1515
- Create a package bundle version in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
1616

17-
<%= config.bin %> <%= command.id %> --bundle “Your bundle name” --definition-file resources/definition.json --target-dev-hub devhub@example.com
17+
<%= config.bin %> <%= command.id %> --bundle “Your bundle name” --definition-file resources/definition.json --target-dev-hub devhub@example.com
1818

1919
# flags.bundle.summary
2020

2121
Name or ID of the package bundle to create a version for.
2222

2323
# flags.definition-file.summary
2424

25-
Path to a definition file, similar to a scratch org definition file, that contains the list of package versions to include in the bundle.
25+
Path to a definition file, similar to a scratch org definition file, that contains the list of package versions to include in the bundle.
2626

2727
# flags.wait.summary
2828

messages/bundle_version_create_list.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To get information about a specific request, run "<%= config.bin %> package bund
1212

1313
# flags.status.summary
1414

15-
Filter the list by the status of the bundle version creation request. Valid values are Queued, Success, or Error.
15+
Status of the installation request, used to filter the list.
1616

1717
# flags.show-conversions-only.summary
1818

@@ -24,7 +24,7 @@ Display additional information, such as the version name and number for each pac
2424

2525
# flags.created-last-days.summary
2626

27-
Filter the list by the number of days since the request was created, starting at 0. Use 0 for today.
27+
Number of days since the request was created, starting at 0. Use 0 for today.
2828

2929
# examples
3030

messages/bundle_version_create_report.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,14 @@ Report on the status of a package bundle version creation request.
44

55
# description
66

7-
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.
7+
The command returns information such as the request's current status and details about the package bundle version being created.
88

9-
# examples
9+
# examples
1010

1111
- Report on a package bundle version creation request:
1212

1313
<%= config.bin %> <%= command.id %> --package-create-request-id 0Ho0x0000000000000
1414

15-
- Report on a package bundle version creation request using an alias:
16-
17-
<%= config.bin %> force:package:bundle:version:create:report -i 0Ho0x0000000000000
18-
1915
# flags.bundle-version-create-request-id.summary
2016

2117
ID of the package bundle version creation request to report on.
@@ -36,11 +32,11 @@ Package Bundle ID
3632

3733
Package Bundle Version ID
3834

39-
# version-name
35+
# version-name
4036

4137
Version Name
4238

43-
# created-date
39+
# created-date
4440

4541
Created Date
4642

messages/bundle_version_list.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ List all package bundle versions in the Dev Hub org.
66

77
- List package bundle versions in the Dev Hub org with the username devhub@example.com:
88

9-
<%= config.bin %> <%= command.id %> --bundle “Your bundle name or ID” --target-dev-hub devhub@example.com
9+
<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com
1010

1111
# namespace
1212

@@ -15,7 +15,7 @@ Namespace Prefix
1515
# name
1616

1717
Name
18-
18+
1919
# id
2020

2121
ID
@@ -34,7 +34,7 @@ Description
3434

3535
# flags.verbose.summary
3636

37-
Display extended details about the package bundle versions.
37+
Display extended details about the package bundle versions.
3838

3939
# error-notification-username
4040

messages/bundle_version_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Retrieve details about a specific package bundle version.
66

77
- Retrieve details about the package bundle version; uses the Dev Hub org with the username devhub@example.com:
88

9-
<%= config.bin %> <%= command.id %> --bundle-version "Your bundle version name or ID" --target-dev-hub devhub@example.com
9+
<%= config.bin %> <%= command.id %> --bundle-version "Your bundle version name or ID" --target-dev-hub devhub@example.com
1010

1111
# flags.bundle-version.summary
1212

0 commit comments

Comments
 (0)