Skip to content

Commit c0d7067

Browse files
fix: edit new refresh sandbox messages, and tweak other messages
1 parent 65de15f commit c0d7067

File tree

3 files changed

+23
-32
lines changed

3 files changed

+23
-32
lines changed

messages/create.sandbox.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,22 @@ Create a sandbox org.
66

77
There are two ways to create a sandbox org: specify a definition file that contains the sandbox options or use the --name and --license-type flags to specify the two required options. If you want to set an option other than name or license type, such as apexClassId, you must use a definition file.
88

9+
You can also use this command to clone an existing sandbox. Use the --clone flag to specify the existing sandbox name and the --name flag to the name of the new sandbox.
10+
911
# examples
1012

1113
- Create a sandbox org using a definition file and give it the alias "MyDevSandbox". The production org that contains the sandbox license has the alias "prodOrg".
1214

13-
<%= config.bin %> <%= command.id %> -f config/dev-sandbox-def.json --alias MyDevSandbox --target-org prodOrg
15+
<%= config.bin %> <%= command.id %> --definition-file config/dev-sandbox-def.json --alias MyDevSandbox --target-org prodOrg
1416

1517
- Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition file. Set the sandbox org as your default.
1618

1719
<%= config.bin %> <%= command.id %> --name mysandbox --license-type Developer --alias MyDevSandbox --target-org prodOrg --set-default
1820

21+
- Clone the existing sandbox with name "ExistingSandbox" and name the new sandbox "NewClonedSandbox". Set the new sandbox as your default org. Wait for 30 minutes for the sandbox creation to complete.
22+
23+
<%= config.bin %> <%= command.id %> --clone ExistingSandbox --name NewClonedSandbox --target-org prodOrg --alias MyDevSandbox --set-default --wait 30
24+
1925
# flags.setDefault.summary
2026

2127
Set the sandbox org as your default org.
@@ -58,7 +64,7 @@ Name of the sandbox org to clone.
5864

5965
# flags.clone.description
6066

61-
The value of clone must be an existing sandbox in the same target-org.
67+
The value of --clone must be an existing sandbox. The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.
6268

6369
# flags.licenseType.summary
6470

messages/refresh.sandbox.md

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,46 @@
11
# summary
22

3-
Refresh (update) a sandbox org by the sandbox name.
3+
Refresh a sandbox org using the sandbox name.
44

55
# description
66

7-
Refresh (update) a sandbox org by the sandbox name, using a definition file for any `SandboxInfo` overrides.
7+
Refreshing a sandbox copies the metadata, and optionally data, from your production org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID.
88

9-
Note that changing a sandbox name during a refresh is not allowed. If changing the sandbox name is desired, instead delete the sandbox and recreate it.
9+
You're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the "org delete sandbox" command. And then recreate it with the "org create sandbox" command and give it a new name.
1010

1111
# examples
1212

1313
- Refresh the sandbox named "devSbx1". The production org that contains the sandbox license has the alias "prodOrg".
1414

15-
<%= config.bin %> <%= command.id %> -n devSbx1 --target-org prodOrg
15+
<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg
1616

17-
- Refresh the sandbox named "devSbx2", overriding the SandboxInfo used when created with the properties in a definition file. The default target org is the production org, so specifying the `--target-org` flag is not necessary in this case.
17+
- Refresh the sandbox named "devSbx2", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.
1818

19-
<%= config.bin %> <%= command.id %> -n devSbx2 -f devSbx2-config.json
19+
<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json
2020

2121
- Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias "prodOrg".
2222

23-
<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json -o prodOrg
23+
<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg
2424

2525
# flags.auto-activate.summary
2626

27-
[default: true] Activates the sandbox after successful refresh.
28-
29-
# flags.auto-activate.description
30-
31-
[default: true] Activates the sandbox after successful refresh.
27+
Activates the sandbox after a successful refresh.
3228

3329
# flags.targetOrg.summary
3430

3531
Username or alias of the production org that contains the sandbox license.
3632

37-
# flags.targetOrg.description
38-
39-
When it refreshes the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the sandbox org.
40-
4133
# flags.definitionFile.summary
4234

43-
Path to a sandbox definition file used to override the configuration used when created.
35+
Path to a sandbox definition file for overriding its configuration when you refresh it.
4436

4537
# flags.definitionFile.description
4638

47-
The sandbox definition file is a blueprint for the sandbox, and is used to change the configuration during a refresh. If no configuration changes from the sandbox creation are desired then simply target the sandbox org using the `--name` flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.
39+
The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.
4840

4941
# flags.name.summary
5042

51-
Name of the existing sandbox org in your production org.
52-
53-
# flags.name.description
54-
55-
Name of the existing sandbox org in your production org.
43+
Name of the existing sandbox org in your production org that you want to refresh.
5644

5745
# flags.wait.summary
5846

@@ -76,23 +64,23 @@ The command immediately displays the job ID and returns control of the terminal
7664

7765
# flags.noPrompt.summary
7866

79-
Don't prompt for confirmation about the sandbox configuration.
67+
Don't prompt for confirmation about the sandbox refresh.
8068

8169
# isConfigurationOk
8270

8371
Is the configuration correct?
8472

8573
# error.SandboxNameLength
8674

87-
The sandbox name "%s" should be 10 or fewer characters.
75+
The sandbox name "%s" must be 10 or fewer characters.
8876

8977
# error.NoSandboxName
9078

9179
Must specify a sandbox name using the `--name` or `--definition-file` flag.
9280

9381
# warning.ConflictingSandboxNames
9482

95-
Different sandbox names were provided with the `--name` ('%s') and `--definition-file` flags ('%s'). Using the value provided by the `--name` flag. If you want to change the name of the sandbox, please delete and create using the new name.
83+
Different sandbox names were provided with the `--name` ('%s') and `--definition-file` flags ('%s'). Using the value provided by the `--name` flag. If you want to change the name of the sandbox, first delete it and then create it again using the new name.
9684

9785
# error.SandboxNotFound
9886

@@ -109,7 +97,7 @@ The sandbox request configuration isn't acceptable.
10997

11098
# error.pollIntervalGreaterThanWait
11199

112-
The poll interval (%d seconds) can't be larger that wait (%d in seconds)
100+
The poll interval (%d seconds) can't be larger than the wait period (%d in seconds).
113101

114102
# sandboxInfoRefreshFailed
115103

src/commands/org/refresh/sandbox.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ export default class RefreshSandbox extends SandboxCommandBase<SandboxProcessObj
5050
public static flags = {
5151
'auto-activate': Flags.boolean({
5252
summary: messages.getMessage('flags.auto-activate.summary'),
53-
description: messages.getMessage('flags.auto-activate.description'),
5453
default: true,
5554
allowNo: true,
5655
}),
@@ -81,7 +80,6 @@ export default class RefreshSandbox extends SandboxCommandBase<SandboxProcessObj
8180
name: Flags.string({
8281
char: 'n',
8382
summary: messages.getMessage('flags.name.summary'),
84-
description: messages.getMessage('flags.name.description'),
8583
parse: (name: string): Promise<string> => {
8684
if (name.length > 10) {
8785
throw messages.createError('error.SandboxNameLength', [name]);
@@ -98,7 +96,6 @@ export default class RefreshSandbox extends SandboxCommandBase<SandboxProcessObj
9896
'target-org': Flags.requiredOrg({
9997
char: 'o',
10098
summary: messages.getMessage('flags.targetOrg.summary'),
101-
description: messages.getMessage('flags.targetOrg.description'),
10299
required: true,
103100
}),
104101
'no-prompt': Flags.boolean({

0 commit comments

Comments
 (0)