Wrote quickstart docs #61
Conversation
| A step by step example | ||
| ---------------------- | ||
|
|
||
| .. include:: quickstart_example.rst.inc |
There was a problem hiding this comment.
Don't see that file (neither in the repo nor in your PR) - did you forget to git add it?
| Archives and repositories | ||
| ------------------------- | ||
|
|
||
| A *Borg-Import archive* is the result of a single backup (``Borg-Import create``). An archive |
There was a problem hiding this comment.
The commandline command invoked by the user is borg-import (lowercase).
So I guess the docs should always write the command in lowercase, only exceptions could be when talking about the project in general (not about the command).
There was a problem hiding this comment.
Hmm, did you just copy that from borg and just replace borg by borg-import?
That reads strange at least if not misleading, so that should be checked and changed at all places.
Also, the goal is not to duplicate the borg docs, they can be referred to by linking, but to document borg-import.
So guess this needs to get done before further review.
2 participants
Issue #16. I have written the quickstart docs in the same style and modified it to represent the new repository.