Skip to content

Commit 8a83fdf

Browse files
Enhance clarity and consistency in authoring bundle doc
Clarified the description of publishing an authoring bundle and improved the explanation of the command's behavior. Adjusted wording for consistency and clarity throughout the document.
1 parent 1f6ca87 commit 8a83fdf

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

messages/agent.publish.authoring-bundle.md

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

3-
Publish an authoring bundle to your org, which results in a new or updated agent.
3+
Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.
44

55
# description
66

77
An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension ".agent") that fully describes the agent using the Agent Script language.
88

9-
When you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then the authoring bundle metadata component is deployed to the org, and all associated agent metadata components, such as the Bot, BotVersion, and GenAiXXX components, are either created or updated. The org then either creates a new agent based on the deployed authoring bundle, or creates a new version of the agent if it already existed. Finally, all the new or changed metadata components associated with the new agent are retrieved back to your local DX project.
9+
When you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then the authoring bundle metadata component is deployed to the org. All associated agent metadata components, such as the Bot, BotVersion, and GenAiXXX components, are either created or updated in the org. Finally, all the new or changed metadata components associated with the new agent are retrieved back to your local DX project.
1010

11-
This command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.
11+
This command uses the API name of the authoring bundle.
1212

1313
# examples
1414

15-
- Publish an authoring bundle with API name MyAuthoringBundle to the org with alias "my-org":
15+
- Publish an authoring bundle by being prompted for its API name; use your default org:
1616

17-
<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --target-org my-org
17+
<%= config.bin %> <%= command.id %>
18+
19+
- Publish an authoring bundle with API name MyAuthoringBundle to the org with alias "my-dev-org":
20+
21+
<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --target-org my-dev-org
1822

1923
# flags.api-name.summary
2024

21-
API name of the authoring bundle you want to publish.
25+
API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.
2226

2327
# flags.api-name.prompt
2428

@@ -30,7 +34,7 @@ Required flag(s) missing: %s.
3034

3135
# error.invalidBundlePath
3236

33-
Invalid bundle path. Provide a valid directory path to an authoring bundle.
37+
Invalid authoring bundle path. Provide a valid directory path to an authoring bundle.
3438

3539
# error.publishFailed
3640

0 commit comments

Comments
 (0)