ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-19 13:07:56 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
6,774 Commits 185 Branches 90 Tags 89 MiB
2a82c2c63c
Commit Graph

910 Commits

Author SHA1 Message Date
Brian Warner
ab091e68de update relnotes and known_issues 2016-03-30 02:25:27 -07:00
Brian Warner
c674b55918 docs: switch to default readthedocs.org theme 2016-03-30 02:18:00 -07:00
Brian Warner
12e54e52f4 README: point to tahoe-lafs.readthedocs.org 
Also add a comment to docs/index.rst, pointing folks who are browsing
the source tree (locally, with an editor) at the formatted version on
readthedocs.org .
 2016-03-30 01:26:47 -07:00
Brian Warner
248a6ceade docs: add .empty to preserve empty _static and _templates 2016-03-30 01:26:47 -07:00
Brian Warner
f81900ee35 format docs for Sphinx 
Added indexes, fixed cross-references.

Also a few pip-related cleanups I noticed along the way.
 2016-03-30 01:26:47 -07:00
Brian Warner
142185bb86 docs: add sphinx index.rst, improve headers 2016-03-29 21:46:11 -07:00
Brian Warner
0acc1dc079 docs: run sphinx-quickstart, move old Makefile 
* .gitignore: add docs/_build (sphinx output directory)
 2016-03-29 21:02:14 -07:00
Brian Warner
2cfe2eb566 INSTALL.rst: more tweaks 2016-03-29 21:01:22 -07:00
Brian Warner
1f1e10d59b docs/OS-X: the $PATH *does* get added correctly 2016-03-28 01:37:35 -07:00
Brian Warner
20787853dd docs: stop suggesting 'activate', too much to explain 
Also it avoids the failure mode where a user forgets to activate the
virtualenv, types the recommended "pip install" command, and installs
stuff directly to their system instead of safely confined inside the
virtualenv.
 2016-03-26 14:13:23 -07:00
Brian Warner
365977bf51 minor docs tweaks 
* use correct fixed-width-font markup
* fix hyperlinks to neighboring (github-side) .rst files
* refer to python-2.7.11 consistently (thanks to PRab for the catch)
 2016-03-26 11:50:44 -07:00
Brian Warner
a63263dc55 minor docs tweaks 2016-03-25 19:25:55 -07:00
Brian Warner
ef1759046d rewrite docs, with pip and virtualenv 2016-03-25 19:22:03 -07:00
Brian Warner
090b592ff8 docs: rename quickstart to INSTALL 2016-03-25 18:26:54 -07:00
Brian Warner
439eaf8c9d preliminary windows docs 2016-03-25 17:27:38 -07:00
Daira Hopwood
0598c830ed Rename distribution from allmydata-tahoe to tahoe-lafs. fixes ticket:2011 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2016-03-25 19:16:01 +00:00
Brian Warner
17886c51aa add docs/desert-island.rst 
refs ticket:2752
 2016-03-22 18:18:49 -07:00
Brian Warner
a8b3c40f46 docs/donations: announce new BTC key, governance+accounting 2016-03-21 01:20:26 -07:00
Brian Warner
136c16e5ec docs: explain what the OS-X package does and does not provide. 2016-03-16 12:38:26 -07:00
Zooko
e3f47919d0 edit to explain to newbies what "the top-level directory" is 
I think confusion about this may behind BG <n0trab@yahoo.com>'s recent report
of failure-to-install on tahoe-dev (2016-02-26).
 2016-03-13 14:35:48 +00:00
Zooko
a7894a8507 edit for accuracy 2016-03-13 14:34:31 +00:00
Zooko
57cc4e919d edit for readability 2016-03-13 14:32:46 +00:00
Brian Warner
71c62b3256 docs/quickstart.rst: mention that py2.6 no longer works 2016-01-28 13:13:44 -08:00
Daira Hopwood
41cf600820 Corrections and clarifications to remote-to-local-sync.rst. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-12-28 19:36:19 +00:00
Daira Hopwood
b5222e3679 Merge pull request #204 from leif/preferred_peers-rebased3 
new feature: preferred storage servers
 2015-12-04 18:01:30 +00:00
Leif Ryge
000c148ad8 drop Python 2.6 (.travis.yml, doc, setup.py) 
Twisted 15 dropped support for it, which causes Travis CI tests to fail on 2.6.
We still theoretically support older versions of Twisted, so perhaps we should
configure Travis to test with those? I think we should drop Python 2.6 in any
case since distros are all on 2.7 now.

I'm leaving Travis running (and ignoring) the failing PyPy tests because I
don't know why that is there.
 2015-12-02 20:18:33 +00:00
Leif Ryge
96eaca6a6d new feature: preferred storage servers 
this includes a squash merge of dca1de6856 which
was previously seen in pull request #128, as well as daira's suggested changes
from pull request #204.
 2015-12-01 19:35:41 +00:00
Daira Hopwood
913082230c Disable bridging of foolscap logging to the Twisted log, and remove docs for it. fixes ticket:2567 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-11-03 17:35:21 +00:00
Ramakrishnan Muthukrishnan
a6dd94646e Move manpage into a heirarchical man1 path. 
Author: Ramakrishnan Muthukrishnan <ram@leastauthority.com>
 2015-09-03 15:18:58 +01:00
Daira Hopwood
7309aed524 Change some instances of "filesystem" that were missed to "file store". 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-07-31 18:21:47 +01:00
Brian Warner
befa4babea update docs for 1.10.2 release 2015-07-30 19:36:45 -07:00
Brian Warner
4bb12887f4 quickstart: Mention python-dev package for Python.h 
Closes ticket:2328.
 2015-07-28 17:47:09 -07:00
Brian Warner
259ba07a5e improve HTTP byte-range docs 2015-07-28 13:28:36 -07:00
Brian Warner
c3608f61d9 webapi.rst: document Range: header on GET requests 
closes ticket#2460
 2015-07-28 13:15:50 -07:00
Daira Hopwood
8cad9f4fd6 Change the separator character in the Magic Folder user interface design doc from '|' to '+'. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-07-21 00:16:40 +01:00
Brian Warner
e03bae7948 docs/how-to-release: add more wiki pages to update 2015-06-26 18:39:29 -07:00
Brian Warner
aeafbc0dd1 release checklist: use signed git tag next time 2015-06-15 18:35:55 -07:00
Brian Warner
5887029b17 update docs for 1.10.1 release 2015-06-15 16:29:37 -07:00
Daira Hopwood
1105278589 Finish user-interface.rst. fixes ticket:2443 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-06-11 21:33:47 +01:00
Daira Hopwood
66178f01da Make a start on the Magic Folder Objective 5 (user interface design) doc. refs ticket:2443 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-06-11 21:33:47 +01:00
Daira Hopwood
b062b76740 Magic Folder design doc: rename "parent DMD" to "collective directory", and don't assume it is mutable. 
(An immutable collective directory could be interesting for some use cases, and is no more difficult to support.)

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-06-06 22:45:42 +01:00
Daira Hopwood
767d01484e remote-to-local-sync.rst: fix a minor error. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-05-29 22:10:33 +01:00
Daira Hopwood
97c33b175b Magic Folder: add remote-to-local sync design doc. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-05-29 03:03:46 +01:00
Daira Hopwood
aa65426ad3 docs/frontends/CLI.rst: clarification. 
The implementation (in [source:src/allmydata/scripts/common.py]) actually tests whether there is a slash anywhere before the first colon.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-05-11 15:05:42 +01:00
Daira Hopwood
7ee151fa55 docs/frontends/CLI.rst: remove a superfluous TODO. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-05-11 14:50:32 +01:00
Brian Warner
97fd19407d Improve docs on 'cp -r', noting the recent 2329 changes 
refs ticket:2329
 2015-05-03 21:49:34 -07:00
Daira Hopwood
17c891f26a Update title of OpenSSL and pyOpenSSL build instructions. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-05-01 22:07:27 +01:00
Daira Hopwood
226559b44c Add OpenSSL and pyOpenSSL build instructions for 32-bit Windows. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-05-01 21:43:43 +01:00
Daira Hopwood
b0fb800a41 Add doc for building pyOpenSSL. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-05-01 18:45:19 +01:00
Daira Hopwood
6f29c79d80 Add discussion and rejection of Change Journals. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-04-02 16:16:46 +01:00
Daira Hopwood
fc0523471f Add link to otf-magic-folder-objective ticket query. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-04-02 16:16:17 +01:00
Daira Hopwood
8fabcbe54b Copyediting. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-04-02 16:15:39 +01:00
Daira Hopwood
14c3bfd12e Collaborative design from Daira and David. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-04-02 15:26:25 +01:00
Daira Hopwood
1b83f7854c Documentation change for AUTO in tub.location. refs #754 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-02-10 18:23:59 +00:00
Daira Hopwood
0d935e8589 Update docs for SFTP public key auth. refs #1411 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2015-01-06 19:14:47 +00:00
Daira Hopwood
a55164673b Change python.org link (https, main download page); editing. 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2014-09-25 18:16:23 +01:00
Zooko
c84ebd3259 reflow to fill-column 77 
and add comment informing your text editor that fill-column=77
 2014-09-25 16:47:19 +00:00
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