borgbackup/borg

test/improve pull backup docs

Open

#5,903 opened on Jul 10, 2021

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

Repository metrics

Stars
 (10,086 stars)
PR merge metrics
 (Avg merge 5d 12h) (91 merged PRs in 30d)

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

Research direction
Review the current pull backup documentation, understand the warnings about numeric owner and others, and propose improvements. Test the documented process with a sample setup if possible.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75