Open
Conversation
flin-8
commented
Apr 17, 2026
|
|
||
| {{.Command.Long}} | ||
| ` + "\n```" + `{{define "T1"}}Usage:{{if .Runnable}} | ||
| ` + "\n```text" + `{{define "T1"}}Usage:{{if .Runnable}} |
Author
There was a problem hiding this comment.
MD040 fenced-code-language - Fenced code blocks should have a language specified
flin-8
commented
Apr 17, 2026
| - [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) | ||
| ` |
Author
There was a problem hiding this comment.
MD047 single-trailing-newline - Files should end with a single newline character
flin-8
commented
Apr 17, 2026
| ## Commands {#octopusCommandLine-Commands} | ||
|
|
||
| ` + "\n`octopus` supports the following commands:\n" + | ||
| ` + "`octopus` supports the following commands:" + |
Author
There was a problem hiding this comment.
MD012 no-multiple-blanks - Multiple consecutive blank lines
flin-8
commented
Apr 17, 2026
| 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), |
Author
There was a problem hiding this comment.
flin-8
commented
Apr 17, 2026
| $ %[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 |
zentron
approved these changes
Apr 17, 2026
Contributor
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. 🤷
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes MD-1770: Fix broken CLI docs update workflow linting
The generated docs PR: https://github.com/OctopusDeploy/docs/pull/3109/changes