docs(cli): improvements for cli help #3060
Open
Conversation
This file contains 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
NickIAm
changed the title
jkowalski
reviewed
Jun 13, 2023
cli/command_snapshot_create.go
Outdated
| A snapshots is a point in time backup of the given <path>. Snapshots are organized by source. | ||
| Each user@host:/path is considered a unique source, and can have policies applied to them. | ||
|
|
||
| Example: $ kopia snapshot create /home/user |
There was a problem hiding this comment.
can you try adding markdown around code smaples (triple backtick):
$ kopia snapshot create /home/user
This would still look decent in --help but will result in nicely formatted website help.
There was a problem hiding this comment.
Sure. I've found I can do something like
`Example:
` + "```" + `
$ kopia snapshot list
` + "```" + `
Continuing....`
And I get this output on the cli
``` $ kopia snapshot list ```
Would using a single backtick work for one liners? I think that would be a good compromise
NickIAm
changed the title
NickIAm
force-pushed
the
doc_improve
branch
2 times, most recently
from
2c5fd69
to
5bf41a7
Compare
NickIAm
changed the title
icepic
reviewed
Aug 11, 2023
site/content/docs/_index.md
Outdated
| @@ -5,7 +5,7 @@ linkTitle: "What is Kopia?" | |||
| weight: 20 | |||
| --- | |||
|
|
|||
| Kopia is a fast and secure open-source backup/restore tool that allows you to create [encrypted](features/#end-to-end-zero-knowledge-encryption) snapshots of your data and save the snapshots to [remote or cloud storage](features/#save-snapshots-to-cloud-network-or-local-storage) of your choice, [to network-attached storage or server](features/#save-snapshots-to-cloud-network-or-local-storage), or [locally on your machine](features/#save-snapshots-to-cloud-network-or-local-storage). Kopia does not 'image' your whole machine. Rather, Kopia allows you to backup/restore any and all files/directories that you deem are important or critical. | |||
| Kopia is a fast and secure open-source backup/restore tool that allows you to create [encrypted](features/#end-to-end-zero-knowledge-encryption) snapshots of your data and save the snapshots to [remote or cloud storage](features/#save-snapshots-to-cloud-network-or-local-storage) of your choice, [to network-attached storage or server](features/#save-snapshots-to-cloud-network-or-local-storage), or [locally on your machine](features/#save-snapshots-to-cloud-network-or-local-storage). Kopia does not 'image' your whole machine. Rather, Kopia allows you to backup/restore any and all files/directories that you deem are important or critical. Kopia is written in Go and runs on Windows 10/11 MacOS and Linux with no extra dependencies required, it is a fully self contained binary. | |||
icepic
reviewed
Aug 11, 2023
…te * snapshot verify * snapshot fix invalid-files * snapshot migrate * ls * restore * added backticks into output to increase web readability for code blocks updates for website * Created page for policy to detail how policies can be used * a few words about kopia being written in Go
new help for repository sync-to
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I've been doing some improvements to the built in --help in a few of the cli snapshot commands. I used the style from the restore command as a guide. Would love some feedback about if this is useful and detailed enough and just general readability.