Commit Graph

803 Commits

Author SHA1 Message Date
Daira Hopwood
6a38a3c54e Rename README.txt to README.rst, and add Travis-CI and Coveralls badges to it.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-09-09 18:51:44 +01:00
Brian Warner
2018ff435a CLI.rst: expand the 'cp -r' subdirectory example 2014-09-02 12:51:13 -07:00
Mark J. Berger
58106e1c0f Documentation updates 2014-09-02 12:51:13 -07:00
Daira Hopwood
1e3a2994e2 Reference README.txt from License section of docs/about.rst, rather than duplicating the license info. fixes #2067
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-09-02 19:37:06 +01:00
Daira Hopwood
c126dc0598 Document ways to use LAFS as a key-value store.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-08-22 15:54:53 +01:00
Zooko Wilcox-O'Hearn
bb13bba2a5 formatting fixes 2014-08-19 18:24:38 +00:00
Zooko Wilcox-O'Hearn
35e90006f4 recommend tahoe backup
and, explain some of why it is awesome, and link to
`<docs/frontends/CLI.rst>`__.
2014-08-19 18:18:33 +00:00
Zooko Wilcox-O'Hearn
f62ff304c5 add warning about performance problems with FUSE 2014-08-05 20:50:30 +00:00
zooko
bc6304ae70 Merge pull request #94 from zooko/link-to-Twisted-ticket-4633
link to Twisted ticket #4633
2014-07-22 06:27:25 +00:00
Zooko Wilcox-O'Hearn
78503591d7 link to Twisted ticket #4633 2014-07-22 05:16:04 +00:00
pataquets
fac1f0d55a Update adding comments as seen in https://tahoe-lafs.org/pipermail/tahoe-dev/2012-May/007365.html
Found it useful. I can't see here clearly if deleting backupdb will affect deduplication and I'd like to clarify here, anyway. Do deduplication depend on backupdb data? TIA.
2014-07-02 13:10:10 -07:00
Brian Warner
a724c09ab8 release docs: recommend Twine for package upload. Closes #2086. 2014-04-25 15:26:23 -07:00
Daira Hopwood
0ef5939477 Remove 'needs-rebalancing' and add 'count-happiness' to checker reports; repair tests. fixes #1784, #2105
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-03-20 16:13:57 +00:00
David
7f0c823b14 Small typo: "stil" -> "still" 2014-01-02 01:59:53 +01:00
Daira Hopwood
419df9b0b4 docs/about.rst: Reword and remove redundancy. Also avoid "(S)FTP".
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-12-04 01:23:11 +00:00
pataquets
857d072ff4 Warn about ambiguities on "client" and "gateway" terms 2013-12-03 17:25:45 +01:00
Zooko Wilcox-O'Hearn
402a66d472 change more links to footnote-style 2013-11-17 15:46:31 +00:00
Zooko Wilcox-O'Hearn
1b0b49aca9 update link to Maildir tips (thanks MK_FG) 2013-11-12 16:37:02 +00:00
Zooko Wilcox-O'Hearn
0bebbe3290 fix warnings from rst2html
Apparently the in-line link syntax with "<>" in them causes these warnings. I
don't know why. I changed them all to a slightly more verbose syntax.

Thanks to Mike Kazantzsev's review comment
(https://github.com/tahoe-lafs/tahoe-lafs/pull/67#commitcomment-4561370), I
moved the links to the end of each section.
2013-11-11 22:04:11 +00:00
Zooko Wilcox-O'Hearn
82579cec96 magic first line tells emacs to use utf8+bom
Add ".. -*- coding: utf-8-with-signature -*-" to the first line of each .rst
file. This tells emacs to treat the file contents as utf-8, and also to prepend
a so-called utf-8 "bom" marker at the beginning of the file. This patch also
prepends those markers to each of those files.
2013-11-08 21:08:05 +00:00
Daira Hopwood
2ac43975ee Fix typo pointed out by CptPlastic.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-10-22 02:31:52 +01:00
Daira Hopwood
3529d31192 Add quotes around command lines in quickstart.rst.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-10-05 18:55:01 +01:00
Zooko Wilcox-O'Hearn
cc0b1ff6ec fix a couple more "file:" links
Making them be just links to "$FILENAME" instead of to "file:$FILENAME" causes
them to be working links on trac and on github. Yay!
2013-10-05 03:44:39 +00:00
Zooko Wilcox-O'Hearn
4e0a8d8d4f fix small issues in formatting
* fix warning from "rst2html --verbose" by not using the in-line hyperlink
  syntax. The warning said::

    known_issues.rst:261: (INFO/1) Hyperlink target "google chart api" is not referenced.

* remove dead code (no-longer-referenced link), thus fixing another warning

* change links to relative files to be just $FILENAME instead of
  file:$FILENAME, which I think will fix the problem of broken links on the
  trac and github, e.g. the link in
  https://tahoe-lafs.org/trac/tahoe-lafs/browser/trunk/docs/known_issues.rst ,
  which ought to go to
  https://tahoe-lafs.org/trac/tahoe-lafs/browser/trunk/docs/cautions.rst , but
  instead goes to file:///cautions.rst
2013-10-05 03:29:00 +00:00
Mark J. Berger
74d37b98fa Fixes the overlapping text in docs/lease-tradeoffs.svg
This fixes ticket #1842. Patch courtesy of PRabahy.
2013-08-07 13:12:59 -04:00
Nathan Wilcox
d5f97cd74a Add a link in accounting-overview.txt to ticket #666. 2013-07-04 12:47:28 -07:00
Brian Warner
a3891d98d7 update release how-to to be closer to current reality 2013-05-01 15:24:24 -07:00
Daira Hopwood
397a95e827 Update terminology in RAIC design doc.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-05-01 22:58:16 +01:00
David-Sarah Hopwood
b94721ad40 docs/proposed/leasedb.rst: Add design doc for leasedb.
This version refs #1834.

Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2013-05-01 22:58:16 +01:00
Brian Warner
d7e71cd22b known_issues, quickstart: add version and anticipated release date 2013-04-24 17:17:45 -07:00
Brian Warner
0ee23117a4 known_issues.rst: get closer to real date 2013-04-24 00:18:43 -07:00
Brian Warner
02975d1887 known_issues: update chart-API text, with suggestions from Leif. refs #1942 2013-04-23 16:39:53 -07:00
Brian Warner
0ba5058f6a docs/nodekeys.rst: explain what node keys are for, with compatibility notes 2013-04-21 23:01:25 -07:00
Daira Hopwood
b06f8cd8d0 Add comments and a caveat in webapi.rst indicating that
the needs-rebalancing field may be computed incorrectly. refs #1115, #1784, #1477

Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-18 23:48:45 +01:00
Daira Hopwood
6899d02854 Minor improvements to webapi.rst.
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-18 23:48:45 +01:00
Leif Ryge
c2a355d405 docs: fixed typos 2013-04-18 11:49:33 -07:00
Daira Hopwood
04c7cfe38b docs/quickstart.rst: update Python 2.7 download URL.
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-18 04:34:01 +01:00
Daira Hopwood
f51f319998 docs/quickstart.rst: update recommended Python version.
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-18 04:30:45 +01:00
Brian Warner
3a18157456 known_issues: document the google-chart-API privacy leak. Refs #1942. 2013-04-14 22:27:03 -07:00
Brian Warner
17fcafbb3f docs: replace emdash characters with plain ASCII 2013-04-09 20:19:58 +01:00
Zooko O'Whielacronx
643eb4f372 s/node/client; mention restart is needed 2013-04-09 19:00:01 +01:00
Zooko O'Whielacronx
07f7d50afa convergence secret doc by CtB, marlowe, zooko 2013-04-09 19:00:01 +01:00
Zooko O'Whielacronx
389251860e attempt to clarify move-vs-relink 2013-04-09 07:08:17 -06:00
Brian Warner
f9335892f2 webapi.rst: small edits to the t=relink section 2013-04-09 12:06:52 +01:00
Daira Hopwood
b1064d456b docs/frontends/webapi.rst: cosmetics.
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-05 19:38:43 +01:00
Daira Hopwood
35f37cc5b8 Change web-API to support t=relink instead of t=move (+ docs and tests). fixes #1732
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-05 19:38:43 +01:00
Daira Hopwood
57d0999425 docs/man/tahoe.1: fix typo and copyright date.
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-03 21:57:32 +01:00
David-Sarah Hopwood
31a7b3dfd1 CREDITS: change my name.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-03-26 19:23:27 +00:00
Brian Warner
0a89b738bc Make introducer.furl unguessable. Closes #1802.
Previously, Introducers always used a swissnum of "introducer", so
anyone who could learn the (public) tubid of the introducer would be
able to connect to and use it. This changes new Introducers to use the
same randomly-generated swissnum as clients and storage servers do, so
that you absolutely must learn the introducer.furl from someone who
knows it already before you can connect.

This change also moves the location of the file that stores
introducer.furl from BASEDIR/introducer.furl to
BASEDIR/private/introducer.furl, since that's where we keep the private
things. The first time an introducer is started with the new code, it
will move any existing BASEDIR/introducer.furl into the new place.

Note that this will not change the FURL of existing introducers: it will
only affect newly created ones. When you change an introducer's FURL,
you must also update all of the nodes (clients and storage servers)
which connect to it, so upgrading it to an unguessable one isn't
something we should do automatically.
2013-03-20 22:40:33 +00:00
David-Sarah Hopwood
5082ca46f4 Update helper.rst to explain new-style config. fixes #1915
Author: Zooko Wilcox-O'Hearn <zooko>
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2013-03-17 16:53:32 +00:00