From aa7a86d089f3fa4792e45eb858691f20f693f46f Mon Sep 17 00:00:00 2001 From: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> Date: Fri, 6 Feb 2026 09:14:33 -0800 Subject: [PATCH] in-progress update to generate markdown. --- templates/command.hbs | 174 ++++++++++++++++++------------------------ 1 file changed, 74 insertions(+), 100 deletions(-) diff --git a/templates/command.hbs b/templates/command.hbs index c299a381..188738a7 100644 --- a/templates/command.hbs +++ b/templates/command.hbs @@ -1,100 +1,74 @@ - - - - - {{!--Not all commands have a minor noun; some are just commandmajornoun:commandverb. This is a sample topic for a commmand with no minor noun.--}} - <codeph otherprops="nolang">{{name}}</codeph>{{#if isClosedPilotCommand}} (Pilot){{/if}}{{#if isOpenPilotCommand}} (Pilot){{/if}}{{#if isBetaCommand}} (Beta){{/if}}{{#if deprecated}} (Deprecated){{/if}} - - - {{#if deprecated}}The command {{name}} has been deprecated{{#if deprecationOptions.version}} and will be removed in v{{deprecationOptions.version}} or later{{/if}}. {{#if deprecated.to}} Use {{deprecated.to}} instead. {{/if}} {{/if}}{{summary}} - - - - - {{!--In the future we’ll add keywords here.--}} - - - - - - - - {{#if isClosedPilotCommand}} -
- We provide the {{name}} command to selected customers through an invitation-only - pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t - guarantee acceptance. The {{name}} command isn’t generally available unless or - until Salesforce announces its general availability in documentation or in press - releases or public statements. We can’t guarantee general availability within any - particular time frame or at all. Make your purchase decisions only on the basis of - generally available products and features. -
{{/if}}{{#if isOpenPilotCommand}} - {{/if}}{{#if isOpenPilotCommand}} -
- We provide the {{name}} command to selected customers through a pilot program - that requires agreement to specific terms and conditions. To be nominated to participate - in the program, contact Salesforce. Pilot programs are subject to change, and we can’t - guarantee acceptance. The {{name}} command isn’t generally available unless or - until Salesforce announces its general availability in documentation or in press - releases or public statements. We can’t guarantee general availability within any - particular time frame or at all. Make your purchase decisions only on the basis of - generally available products and features. -
{{/if}}{{#if isBetaCommand}} -
- This feature is a Beta Service. Customers may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms (https://www.salesforce.com/company/legal/agreements/). -
{{/if}} - {{#if help}} -
- <ph>Description for <codeph otherprops="nolang">{{name}}</codeph></ph> - {{#each help}} - {{#isCodeBlock this}}{{this}}{{else}}

{{this}}

{{/isCodeBlock}} - {{/each}} -
- {{/if}} - {{#if examples}} -
- <ph>Examples for <codeph otherprops="nolang">{{name}}</codeph></ph> - {{#each examples}} - {{#if this.description}}

{{this.description}}

{{/if}} - {{#if this.commands}} - {{#each this.commands}} - {{#isCodeBlock this}}{{this}}{{else}}

{{this}}

{{/isCodeBlock}} - {{/each}} - {{/if}} - {{/each}} -
- {{/if}} - {{#if parameters}} -
- <ph>Flags</ph> -
- {{#each parameters}} - -
{{#if char}}-{{char}} | {{/if}}--{{name}}{{#if hasValue}} {{toUpperCase name}}{{/if}}
- {{#if deprecated}}
The parameter --{{name}} has been deprecated and will be removed in v{{nextVersion deprecated.version}}.0 or later. Use {{deprecated.to}} instead.
- {{/if}}
{{#if optional}}Optional{{else}}Required{{/if}}
-
{{#each description}}

{{[]}}

{{/each}}
{{#if kind}} -
Type: {{kind}}
{{/if}}{{#if options}} -
Permissible values are: {{join options}}
{{/if}}{{#if defaultFlagValue}} -
Default value: {{defaultFlagValue}}
{{/if}} - - {{/each}} -
-
- {{/if}} - {{#if aliases}} -
- <ph>Aliases for <codeph otherprops="nolang">{{name}}</codeph></ph> - {{#each aliases}} - {{this}} - {{/each}} -
- {{/if}} - - +{{!--Not all commands have a minor noun; some are just commandmajornoun:commandverb. This is a sample topic for a commmand with no minor noun.--}} +# {{name}}{{#if isClosedPilotCommand}} (Pilot){{/if}}{{#if isOpenPilotCommand}} (Pilot){{/if}}{{#if isBetaCommand}} (Beta){{/if}}{{#if deprecated}} (Deprecated){{/if}} +{{#if deprecated}}The command {{name}} has been deprecated{{#if deprecationOptions.version}} and will be removed in v{{deprecationOptions.version}} or later{{/if}}. {{#if deprecated.to}} Use {{deprecated.to}} instead. {{/if}} {{/if}} +{{summary}} + +{{#if isClosedPilotCommand}} +:::note +We provide the {{name}} command to selected customers through an invitation-only pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance. The {{name}} command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. +::: + +{{/if}} +{{#if isOpenPilotCommand}} +:::note +We provide the {{name}} command to selected customers through a pilot program that requires agreement to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Pilot programs are subject to change, and we can’t guarantee acceptance. The {{name}} command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. +::: + +{{/if}} +{{#if isBetaCommand}} +:::note +This feature is a Beta Service. Customers may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms (https://www.salesforce.com/company/legal/agreements/). +::: + +{{/if}} +{{#if help}} +## Description for `{{name}}` + +{{#each help}} +{{#isCodeBlock this}}`{{this}}`{{else}}{{this}}{{/isCodeBlock}} + +{{/each}} +{{/if}} +{{#if examples}} +## Examples for `{{name}}` + +{{#each examples}} +{{#if this.description}}{{this.description}}{{/if}} + +{{#if this.commands}} +{{#each this.commands}} +{{#isCodeBlock this}}```bash +{{this}} +```{{else}}{this}}{{/isCodeBlock}} + +{{/each}} +{{/if}} +{{/each}} +{{/if}} +{{#if parameters}} +## Flags + +{{#each parameters}} +{{#if char}}`-{{char}}` | {{/if}}`--{{name}}`{{#if hasValue}} `{{toUpperCase name}}`{{/if}} + +{{#if deprecated}}The parameter `--{{name}}` has been deprecated and will be removed in v{{nextVersion deprecated.version}}.0 or later. Use `{{deprecated.to}}` instead. + +{{/if}}{{#if optional}}Optional{{else}}Required{{/if}} + +{{#each description}}{{[]}}{{/each}}{{#if kind}} + +Type: {{kind}}{{/if}}{{#if options}} + +Permissible values are: {{join options}}{{/if}}{{#if defaultFlagValue}} + +Default value: {{defaultFlagValue}}{{/if}} + +{{/each}} +{{/if}} +{{#if aliases}} +## Aliases for `{{name}}` + +{{#each aliases}} +`{{this}}` +{{/each}} +{{/if}}