From: Zooko O'Whielacronx Date: Wed, 3 Mar 2010 23:19:02 +0000 (-0800) Subject: docs: a few small edits to try to guide newcomers through the docs X-Git-Url: https://git.rkrishnan.org/pf/content//%22file:/%22?a=commitdiff_plain;h=34a50b857ad506d1db4a5cf714d47a9641d2e21e;p=tahoe-lafs%2Ftahoe-lafs.git docs: a few small edits to try to guide newcomers through the docs These edits were suggested by my watching over Jake Appelbaum's shoulder as he completely ignored/skipped/missed install.html and also as he decided that debian.txt wouldn't help him with basic installation. Then I threw in a few docs edits that have been sitting around in my sandbox asking to be committed for months. --- diff --git a/README b/README index 27f60b64..79b28dc4 100644 --- a/README +++ b/README @@ -1,11 +1,14 @@ -Welcome to the Tahoe-LAFS project [1], a secure, decentralized, +Welcome to the Tahoe-LAFS project--a secure, decentralized, fault-tolerant filesystem. All of the source code is available under a Free Software, Open Source licence (or two). -Please see docs/about.html for an introduction, docs/install.html for -install instructions, docs/running.html for usage instructions. +To get started please read + + * docs/install.html + * docs/about.html + * docs/running.html Finally, see docs/known_issues.txt for things that you need to know about if you are relying on Tahoe to store your valuable data. -[1] http://allmydata.org +http://tahoe-lafs.org diff --git a/docs/debian.txt b/docs/debian.txt index 03e0f984..53a11181 100644 --- a/docs/debian.txt +++ b/docs/debian.txt @@ -1,7 +1,7 @@ = Debian Support = -One convenient way to deploy a Tahoe grid is via debian packages. +One convenient way to install Tahoe-LAFS is with debian packages. == Building Debian Packages == diff --git a/docs/install.html b/docs/install.html index 5fd34151..2c3b734b 100644 --- a/docs/install.html +++ b/docs/install.html @@ -10,11 +10,11 @@

About Tahoe-LAFS

Welcome to the Tahoe-LAFS project, a secure, decentralized, fault-tolerant filesystem. About Tahoe-LAFS. +

Welcome to the Tahoe-LAFS project, a secure, decentralized, fault-tolerant filesystem. About Tahoe-LAFS.

How To Install Tahoe-LAFS

This procedure has been verified to work on Windows, Cygwin, Mac, many flavors of Linux, Solaris, FreeBSD, OpenBSD, and NetBSD. It's likely to work on other platforms. If you have trouble with this install process, please write to the tahoe-dev mailing list, where friendly hackers will help you out.

This procedure works on Windows, Cygwin, Mac, many flavors of Linux (including Debian), Solaris, FreeBSD, OpenBSD, and NetBSD. It's likely to work on other platforms. If you have trouble with this install process, please write to the tahoe-dev mailing list, where friendly hackers will help you out.

Install Python

@@ -26,7 +26,7 @@

Download the 1.6.1 release zip file:

http://allmydata.org/source/tahoe/releases/allmydata-tahoe-1.6.1.zip

+ href="http://tahoe-lafs.org/source/tahoe-lafs/releases/allmydata-tahoe-1.6.1.zip">http://allmydata.org/source/tahoe-lafs/releases/allmydata-tahoe-1.6.1.zip

Build Tahoe-LAFS

diff --git a/misc/simulate_load.py b/misc/simulate_load.py index de7437c7..50ff45b9 100644 --- a/misc/simulate_load.py +++ b/misc/simulate_load.py @@ -1,5 +1,6 @@ #!/usr/bin/env python +# WARNING. There is a bug in this script so that it does not simulate the actual Tahoe Two server selection algorithm that it was intended to simulate. See http://allmydata.org/trac/tahoe-lafs/ticket/302 (stop permuting peerlist, use SI as offset into ring instead?) import random diff --git a/src/allmydata/scripts/tahoe_cp.py b/src/allmydata/scripts/tahoe_cp.py index 2b82bb60..6e639e0d 100644 --- a/src/allmydata/scripts/tahoe_cp.py +++ b/src/allmydata/scripts/tahoe_cp.py @@ -212,7 +212,7 @@ class TahoeFileTarget: PUT(self.url, inf) # TODO: this always creates immutable files. We might want an option # to always create mutable files, or to copy mutable files into new - # mutable files. + # mutable files. ticket #835 class TahoeDirectorySource: def __init__(self, nodeurl, cache, progressfunc):