mirror of
https://github.com/kopia/kopia.git
synced 2025-12-23 22:57:50 -05:00
docs(site): fix CLI command docs (#4979)
Also, minor updates for contrib docs
This commit is contained in:
@@ -6,9 +6,10 @@ toc_hide: true
|
||||
|
||||
> NOTE: Those guidelines are preliminary and will change as the project grows and expands in scope.
|
||||
|
||||
## Contacting Developers
|
||||
## Code Documentation
|
||||
|
||||
* Using [Slack](https://slack.kopia.io) is the quickest way to get in touch with developers.
|
||||
Kopia is primarily written using [The Go Programming Language](https://go.dev/doc/).
|
||||
The source code documentation can be found on [godoc.org](https://godoc.org/github.com/kopia/kopia/repo).
|
||||
|
||||
## Submitting issues
|
||||
|
||||
@@ -35,3 +36,7 @@ toc_hide: true
|
||||
- `<description>` is a clear description of a PR.
|
||||
- Follow the pattern precisely, as the title-checker cares about capitalization parentheses, and spaces.
|
||||
- For example: `feat(cli): Add new policy rule --new-feature-x to enable using feature x`.
|
||||
|
||||
## Contacting Community
|
||||
|
||||
* Use [Slack](https://slack.kopia.io) to reach out to other developers.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Command Line"
|
||||
linkTitle: "Command Line"
|
||||
title: "Command-Line Reference"
|
||||
linkTitle: "Command-Line Reference"
|
||||
weight: 10
|
||||
---
|
||||
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
---
|
||||
title: "Go API"
|
||||
linkTitle: "Go API"
|
||||
weight: 1
|
||||
---
|
||||
|
||||
Kopia provides programmatic API for accessing the repository.
|
||||
|
||||
The documentation can be found on [godoc.org](https://godoc.org/github.com/kopia/kopia/repo).
|
||||
@@ -1,10 +1,9 @@
|
||||
---
|
||||
title: "Command-Line References"
|
||||
linkTitle: "Command-Line References"
|
||||
title: "Reference"
|
||||
linkTitle: "Reference"
|
||||
weight: 40
|
||||
hide_summary: true
|
||||
no_list: true
|
||||
---
|
||||
|
||||
* [Go API Reference](go-api/)
|
||||
* [Command-Line Reference](command-line/)
|
||||
|
||||
@@ -311,8 +311,8 @@ func generateSubcommandPage(fname string, cmd *kingpin.CmdModel) {
|
||||
}
|
||||
}
|
||||
|
||||
fmt.Fprintf(f, "```shell\n$ kopia %v%v%v\n```\n\n", cmd.FullCommand, flagSummary, argSummary) //nolint:errcheck
|
||||
fmt.Fprintf(f, "%v\n\n", escapeFlags(cmd.Help)) //nolint:errcheck
|
||||
fmt.Fprintf(f, "```shell\n$ kopia %v%v%v\n```\n\n", cmd.FullCommand, flagSummary.String(), argSummary.String()) //nolint:errcheck
|
||||
fmt.Fprintf(f, "%v\n\n", escapeFlags(cmd.Help)) //nolint:errcheck
|
||||
|
||||
emitFlags(f, cmd.Flags)
|
||||
emitArgs(f, cmd.Args)
|
||||
|
||||
Reference in New Issue
Block a user