Conversation
|
|
||
| {{.Command.Long}} | ||
| ` + "\n```" + `{{define "T1"}}Usage:{{if .Runnable}} | ||
| ` + "\n```text" + `{{define "T1"}}Usage:{{if .Runnable}} |
There was a problem hiding this comment.
MD040 fenced-code-language - Fenced code blocks should have a language specified
| - [Octopus CLI](/docs/octopus-rest-api/cli) | ||
| - [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)` | ||
| - [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) | ||
| ` |
There was a problem hiding this comment.
MD047 single-trailing-newline - Files should end with a single newline character
| ## Commands {#octopusCommandLine-Commands} | ||
|
|
||
| ` + "\n`octopus` supports the following commands:\n" + | ||
| ` + "`octopus` supports the following commands:" + |
There was a problem hiding this comment.
MD012 no-multiple-blanks - Multiple consecutive blank lines
| Short: "Create an AWS account", | ||
| Long: "Create an AWS account in Octopus Deploy", | ||
| Example: heredoc.Docf("$ %s account aws create", constants.ExecutableName), | ||
| Example: heredoc.Docf("%s account aws create", constants.ExecutableName), |
There was a problem hiding this comment.
| $ %[1]s project variable update | ||
| %[1]s project variable list "Deploy Web App" | ||
| %[1]s project variable view --name "DatabaseName" --project Deploy | ||
| %[1]s project variable update |
There was a problem hiding this comment.
MD014 commands-show-output - Dollar signs used before commands without showing output
There was a problem hiding this comment.
@zentron if we think it's important to keep the $ at the front, then we can override the linting rule
zentron
left a comment
zentron
left a comment
There was a problem hiding this comment.
Scanning through the changes it all looks reasonable, im assuming the format must have changed at some point since it was last generated. 🤷
2 participants
Fixes MD-1770: Fix broken CLI docs update workflow linting
The generated docs PR: https://github.com/OctopusDeploy/docs/pull/3109/changes