mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity
1,552 Commits 9 Branches 135 Tags 55 MiB
Commit Graph

35 Commits

Author SHA1 Message Date
Thomas Waldmann b787ac6ea1 docs: remove api docs (too much breakage on rtd) 2015-10-27 20:46:57 +01:00
Antoine Beaupré 60d04b05a0 show the README on the homepage 
instead of a boring table of contents, try to show our more exciting README file

it's still a wall of text, but at least all the buzzwords and highlights are there

ideally, the table of contents would be in the sidebar, but i don't know how to do that
 2015-10-07 17:56:24 -04:00
Antoine Beaupré b87be856f9 include authors, and move to docs 
also keep a symlink for backwards compatibility
 2015-10-07 17:54:43 -04:00
Antoine Beaupré a2cf0025c2 add automatically generated API 
this is a crude hack for now, and could use a better table of contents

but at least we have some way of linking and showing the different
internal functions

the next phase here is obviously to document that API through the
addition of docstrings. a static api.rst could also be easier to read,
but maybe that could go through some docstrings as well, to be tested
 2015-09-30 18:35:57 -04:00
Thomas Waldmann d65ca51d54 deduplicate and refactor the docs 
README.rst (shown on github and also at the start of the html docs) shall
be like an elevator speech - convince readers in a very short time.
this is most important, everything else can come after we got the reader's interest.

include README into docs to avoid duplication.
also include CHANGES into docs.
add developer docs, move examples from tox.ini there
add separate support docs
remove glossary, most of what was there can be understood by an admin from context
move attic and compatibility note to the end
 2015-08-06 12:59:51 +02:00
Thomas Waldmann f330b4bd2a some doc updates, see below 
faq about redundancy / integrity
compression is optional
having borg installed on backup server is optional (but faster)
cygwin installation tipps
do not document passphrase encryption mode example, use keyfile mode
 2015-07-14 21:31:35 +02:00
Thomas Waldmann 9ead4097cf we are now on #borgbackup on chat.freenode.net 
it seems like there is currently no bureaucracy required, freenode web site says group registration is suspended.
i also asked on the freenode channel, they said just make sure you are right here and use it. so we do that now.
 2015-06-29 23:07:07 +02:00
Thomas Waldmann 37c923d4f0 misc. minor docs fixes 2015-05-15 01:50:45 +02:00
Thomas Waldmann f30d05fcd4 docs: install docs, faq improvements, other minor changes 2015-05-14 20:47:08 +02:00
Thomas Waldmann 35d06afd6b get rid of some .borg, be consistent with the backup repo name and path 
it's pretty useless to have .borg as a directory extension, especially
since there is a README in there stating that this is a borg repo.

conistency:
"backup" is always used as relative backup repository path
"/mnt/backup" is always used as absolute repository path
 2015-05-13 15:02:33 +02:00
Thomas Waldmann cb5c9b63b3 fork: s/attic/borg/g, fix URLs, add new section to AUTHORS 
use borg instead attic except at the places where it was used:
- as toplevel package name, directory name, file name
- to refer to original attic

remove sphinx upload make command, will be replaced by github.io site later

remove references to binary downloads and linux packages for now

remove some software name references, fix grammar

use borgbackup rather than borg-backup (or borg) in URLs,
less name collision issues, better search results, no validity issues with "-"
 2015-05-13 15:02:33 +02:00
Thomas Waldmann f9d90482c4 merged master 2015-05-10 16:36:10 +02:00
Jonas Borgström c79b5357f8 Improve installatoin instructions. 
Specifically refer to pip3 instead of pip to avoid potential
confusion.

Also mention virtualenv
 2015-04-27 22:35:06 +02:00
Antoine Beaupré 9f0ed2a8c0 clarify some bits I missed 2014-12-16 10:03:20 -05:00
Jonas Borgström 02a8172eee docs: More improvements 2014-04-06 22:47:22 +02:00
Jonas Borgström f685eb162c docs: New layout and some initial documentation improvements 2014-04-05 20:24:46 +02:00
Jonas Borgström c20aba8c4c docs: Add link to Slackware packages 2014-03-12 21:00:30 +01:00
Dan Christensen 0b9969d162 Various minor documentation updates: mention sshfs, Linux packages, 
minor changes to prose, etc.
 2014-02-03 21:26:36 -05:00
Jonas Borgström 9c80089c04 Documentation update. 
Added links to Debian, Ubuntu and Arch linux packages and
added a comment about Cython dependency when installing from git.

Closes #21.
 2014-01-26 12:51:56 +01:00
Jonas Borgström 9ebeb0f98d Documentation: Added info about mailing list 2013-08-06 22:17:28 +02:00
Jonas Borgström a51a10a96c More documentation improvements. 2013-08-04 23:20:22 +02:00
Jonas Borgström a35339f2c2 Renamed commands.rst to usage.rst 2013-08-04 21:23:12 +02:00
Jonas Borgström b6c8392c03 More documentation work 2013-08-03 13:05:06 +02:00
Jonas Borgström e016a4ee92 A new Attic sphinx theme 2013-08-03 13:04:57 +02:00
Jonas Borgström b718a443a8 Project rename 2013-07-09 20:14:18 +02:00
Jonas Borgström a9272ce913 Update documentation 2013-07-08 21:19:50 +02:00
Jonas Borgström f827b99ffe Improved documentation. 2013-07-05 12:32:56 +02:00
Jonas Borgström 6052a1ed74 Minor docs tweaks 2013-07-03 22:38:07 +02:00
Jonas Borgström 445b862d8c Added more installation documentation. 2013-06-30 21:30:17 +02:00
Jonas Borgström a32c5651c1 Docs improvements 2013-06-29 23:58:31 +02:00
Jonas Borgström 263b7f6fdd Switch to our own xattr implementation 2013-06-27 13:28:59 +02:00
Jonas Borgström c4ec578090 Rename store -> repository 2013-06-20 12:44:58 +02:00
Jonas Borgström 44b3757865 Rename purge command to prune 2011-11-22 21:47:17 +01:00
Jonas Borgström d130fa2cfb Improved documentation 2011-11-06 16:59:14 +01:00
Jonas Borgström be8a14bd7e Initial documentation 2011-11-05 19:43:23 +01:00