mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity
2,712 Commits 9 Branches 138 Tags 59 MiB
Commit Graph

72 Commits

Author SHA1 Message Date
Thomas Waldmann 6b6ddecd93 document windows 10 linux subsystem install 
also add note about remote repos being broken on cygwin.
 2016-12-17 00:25:49 +01:00
Marian Beermann 64428da030 README: fix code-block without an argument 2016-11-27 20:16:41 +01:00
Antoine Beaupré fbada18b0d display README correctly on PyPI 
I have discovered that PyPI is way more sensitive to RST warnings than
other platforms: warnings and errors will make the document not show
up correctly, which is currently the case here:

https://pypi.python.org/pypi/borgbackup/

the suggested changes remove Sphinx-specific markup from the output,
namely the badges and `|replacement|` patterns, but also the
`higlight` directive. this also requires adding tags to the README to
mark the badges to remove and removal of the `none` argument for the
`.. code-block::` element which was not having any significant in
Sphinx anyways.
 2016-11-24 09:09:15 -05:00
Antoine Beaupré 319ecd81bb fix links in standalone README 
github and standalone docutils don't parse :ref: tags correctly
 2016-11-04 20:58:28 -04:00
Antoine Beaupré 0cda9d6bd3 add link to security contact in README 2016-11-04 20:58:27 -04:00
Antoine Beaupré b4d0388785 move security verification to support section 
the rationale is to simplify the README file to the bare
minimum. security researchers will be able to find the contact
information if they look minimally and people installing the software
will find a link where relevant (in binary releases only, since all
the others have other trust paths)
 2016-11-04 20:58:27 -04:00
Antoine Beaupré 5def2350d0 fix PDF rendering structure 
without those changes, all of the toctree document headings do not
show up. they are considered to be "below" the last heading of the
README file.

we also remove the "Notes" section from the readme as there is only
one note, regarding the fork.

we introduce a stub "introduction" element in the toctree, otherwise
it is impossible for the PDF rendered to render the README correctly.

this is to workaround a bug in the PDF renderer.
 2016-11-04 16:01:18 -04:00
Antoine Beaupré 7f9a147e46 move fork differences to FAQ 
it seems now that the fork is more of historical value than a current
thing. people interested in the differences between borg and attic can
look in the FAQ, but I do not see why this is present in the README.

a new section regarding compatibility is created to keep that warning
in place.
 2016-11-04 12:34:41 -04:00
Marian Beermann ac8d65cc47 Fix second block in "Easy to use" section not showing on GitHub 
Fixes #1576
 2016-09-06 13:03:59 +02:00
Thomas Waldmann 45d72722af add bestpractices badge 2016-09-03 21:11:47 +02:00
Thomas Waldmann 2e1cf17dd5 add release signing key / security contact to README, fixes #1560 2016-09-03 19:23:40 +02:00
Lee Bousfield 0a4a95eb17
Remove trailing whitespace 2016-07-27 10:05:51 -04:00
Thomas Waldmann cf4d761042 docs: fix the highlighting 
default is "python", that's why some help fragments and bash scripts looked strange.
 2016-07-11 23:16:53 +02:00
Thomas Waldmann 20eab2b5c8 update frontpage / support docs 
less items in frontpage link list
add IRC chat link
minor other changes
 2016-07-04 22:37:24 +02:00
Thomas Waldmann 4b73ebc613 update readthedocs urls, fixes #991 2016-04-29 03:19:27 +02:00
Thomas Waldmann bc854e3e64 docs: use /path/to/repo, fixes #901 
/mnt/backup was confusing as people like to mount their backup disk on /mnt/backup,
but borg init /mnt/backup does not work if that directory already exists because it is
the mountpoint. it would work, if /mnt was the mountpoint, but that is not obvious
and also unusual.
 2016-04-15 03:35:37 +02:00
petrcech 351da4c88f Update README.rst to new changelog location 
Update README.rst to new changelog location in docs/changes.rst
 2016-03-03 07:08:19 +01:00
Thomas Waldmann 64c7b5db21 fix travis badge 2016-02-27 19:05:46 +01:00
Thomas Waldmann af2eaaabd4 update and improve docs 
use the travis status image as png as svg does not show an image in firefox.
 2016-02-27 17:22:56 +01:00
Herover 29b84a1b43 Use https on updated license link 2016-01-25 13:33:48 +01:00
Herover 7cb6b5657a Fix dead link to license 2016-01-24 19:26:05 +01:00
Stefan Tatschner 897c763a5b Fix markup in README.rst 
Github generated wrong markup, because of a few whitespace errors.
This patch fixes the rst markup of the README.rst file.
 2016-01-18 16:30:27 +01:00
Robin Schneider 576348a9d4
Use HTTPS everywhere. Especially when the website already redirects to HTTPS. 2016-01-17 22:31:08 +01:00
Jerry Jacobs a1e1ce552c Update README.md with doc|stable shield, minor markup fixes on docs/deployment.rst 2016-01-15 20:02:42 +01:00
Thomas Waldmann 546052ed92 README: minor grammar fix, minor other changes 2015-12-20 16:38:38 +01:00
Thomas Waldmann c4610c1edf remove old mailing list archive references 
the old archives were merged into the new archives.
 2015-12-12 22:02:10 +01:00
Daniel Dent 8c91923fb5 Load over SSL (avoids mixed content) 2015-12-06 18:08:32 -08:00
Thomas Waldmann 1f8b64cc1f readme: add note about clientside encryption 2015-12-03 17:35:52 +01:00
Thomas Waldmann f1f2e78ced docs: move related projects to resources section 2015-12-03 17:13:39 +01:00
Thomas Waldmann dcab7dd8a7 new mailing list borgbackup@python.org 
also: remove mailing list and irc channel address from development docs,
it is enough to have this information on the main page and on the support page.
 2015-11-18 15:40:23 +01:00
jungle-boogie 5942b79740 correct install link 2015-11-14 16:13:25 -08:00
Jan bc6b92f130 Fix for link to "The Borg collective" 
Fixed the link to "The Borg collective".
 2015-11-06 16:22:05 +01:00
Thomas Waldmann 42fc22840c embed the asciinema preview image / link into the README 2015-10-25 00:02:50 +02:00
Antoine Beaupré 500c2a8a20 fix warnings in docs generation 2015-10-19 11:09:28 -04:00
Thomas Waldmann 6712bdf456 include a list of major changes compared to attic into the README, fixes #224 2015-10-17 22:27:59 +02:00
Thomas Waldmann e7f25d7821 docs: use zlib,6 compression in some examples, fixes #275 
This is what attic used by default, but borgbackup defaults to "no compression".

I just adjusted the command invocation, so we can keep the example output
(which shows that stuff was compressed).

Also: add FAQ item about compression.
 2015-10-16 01:18:37 +02:00
Antoine Beaupré f31b4a639b fix headings in README 
this makes it consistent with the rest of the documentation
 2015-10-12 23:36:48 -04:00
Antoine Beaupré 6b604ac28c Merge remote-tracking branch 'origin/master' into rtd-theme 
Conflicts:
	README.rst
 2015-10-12 23:29:45 -04:00
Antoine Beaupré e59045fd24 move links from the sidebar to the readme 
it seems sidebar links are not supported by the RTD theme just yet: https://github.com/snide/sphinx_rtd_theme/issues/254
 2015-10-12 23:27:59 -04:00
Antoine Beaupré da2ec7995f fix homepage URL in all remaining places 
we update the documentation to mention the automatic updates, and also
remove the hack in the makefile to update the github.io pages, which
are gone.
 2015-10-09 15:54:04 -04:00
Antoine Beaupré 6cd6e286af clarify which systems have binaries 2015-10-07 18:37:35 -04:00
Antoine Beaupré 5f4db6487a fix README links so they work in github 2015-10-07 18:33:43 -04:00
Antoine Beaupré e2f3527353 don't duplicate OS list 
we merge the "easy installation" and "platforms" paragraphs together in a neater phrasing
 2015-10-07 18:32:21 -04:00
Antoine Beaupré ef5d8d0879 fix link to install docs 2015-10-07 18:04:36 -04:00
Antoine Beaupré 1579be33df fix links to changelog and authors 2015-10-07 17:54:43 -04:00
Antoine Beaupré 6629772760 make readme a little more readable 
link to source documents for people that are reading just the README without a web browser
hyperlink to the changes document as well
 2015-10-07 17:54:43 -04:00
Thomas Waldmann a3d967bdff hint to single-file pyinstaller binaries from README 2015-09-28 00:41:40 +02:00
Thomas Waldmann ff64b4c424 be more precise about OpenBSD/NetBSD support 
xattrs/ACLs need platform specific code and new have none (yet) for them.
 2015-09-16 11:53:53 +02:00
Thomas Waldmann f138d06dd5 more platform support, works on py 3.5 
xattrs and ACLs on OpenBSD and NetBSD need development or adaptation of
the platform-specific code.
 2015-09-16 11:44:53 +02:00
Thomas Waldmann 1d16e7a37c compression: update / refine docs 2015-08-15 15:45:15 +02:00