-
Notifications
You must be signed in to change notification settings - Fork 14
Fix public doc linting issues #591
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -201,7 +201,7 @@ navOrder: {{.Position}} | |
| import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; | ||
|
|
||
| {{.Command.Long}} | ||
| ` + "\n```" + `{{define "T1"}}Usage:{{if .Runnable}} | ||
| ` + "\n```text" + `{{define "T1"}}Usage:{{if .Runnable}} | ||
| {{.UseLine}}{{end}}{{if .HasAvailableSubCommands}} | ||
| {{.CommandPath}} [command]{{end}}{{if gt (len .Aliases) 0}} | ||
|
|
||
|
|
@@ -233,15 +233,16 @@ Use "{{.CommandPath}} [command] --help" for more information about a command.{{e | |
| ## Examples | ||
|
|
||
| <SamplesInstance /> | ||
| ` + "\n```" + ` | ||
| ` + "\n```bash" + ` | ||
| {{ .Command.Example }} | ||
| ` + "\n```\n" + ` | ||
| {{- end }} | ||
|
|
||
| ## Learn more | ||
|
|
||
| - [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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. MD047 single-trailing-newline - Files should end with a single newline character |
||
|
|
||
| const indexTemplate = `--- | ||
| layout: src/layouts/Default.astro | ||
|
|
@@ -263,7 +264,8 @@ The Octopus CLI is built and maintained by the Octopus Deploy team, but it is al | |
|
|
||
| ## Commands {#octopusCommandLine-Commands} | ||
|
|
||
| ` + "\n`octopus` supports the following commands:\n" + | ||
| ` + "`octopus` supports the following commands:" + | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. MD012 no-multiple-blanks - Multiple consecutive blank lines |
||
| ` | ||
| {{range .Pages}} | ||
| - **[{{.Title}}]({{.RelativePath}})**: {{.Command.Short}}.{{end}}` | ||
| - **[{{.Title}}]({{.RelativePath}})**: {{.Command.Short}}.{{end}} | ||
| ` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,9 +2,10 @@ package create | |
|
|
||
| import ( | ||
| "fmt" | ||
| "github.com/OctopusDeploy/cli/pkg/cmd" | ||
| "os" | ||
|
|
||
| "github.com/OctopusDeploy/cli/pkg/cmd" | ||
|
|
||
| "github.com/OctopusDeploy/cli/pkg/util" | ||
| "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments" | ||
|
|
||
|
|
@@ -67,7 +68,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command { | |
| Use: "create", | ||
| 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| Aliases: []string{"new"}, | ||
| RunE: func(c *cobra.Command, _ []string) error { | ||
| opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
MD040 fenced-code-language - Fenced code blocks should have a language specified