borgbackup/borg

test/improve pull backup docs

Open

#5903 opened on Jul 10, 2021

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Python (10,086 stars) (732 forks)batch import
documentationhelp wanted

Description

The pull backup docs (see deployment / ...) have 2 rather severe warnings and one warning that --numeric-ownermight be better.

This should be tried / improved / cleaned up via a PR by someone who actually uses pull backups (I don't).

https://github.com/borgbackup/borg/blob/949ca476527422909c8e89ed087cd6a9ce0a957b/docs/deployment/pull-backup.rst

Contributor guide

Tech stack
pythonshell
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
basic knowledge of borg pull backupsfamiliarity with borg documentation style
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review the current pull backup documentation at the linked file. Understand the two severe warnings and the suggestion about numeric owner. Test the pull backup workflow to verify the warnings and decide on improvements. Then propose changes via a pull request.