]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/commitdiff
docs: a few small edits to try to guide newcomers through the docs
authorZooko O'Whielacronx <zooko@zooko.com>
Wed, 3 Mar 2010 23:19:02 +0000 (15:19 -0800)
committerZooko O'Whielacronx <zooko@zooko.com>
Wed, 3 Mar 2010 23:19:02 +0000 (15:19 -0800)
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.

README
docs/debian.txt
docs/install.html
misc/simulate_load.py
src/allmydata/scripts/tahoe_cp.py

diff --git a/README b/README
index 27f60b6475f664183208ada7642b0ccaf59cda6d..79b28dc4f4e142bb0448d343ddab85a41da1f2fd 100644 (file)
--- 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
index 03e0f9849c007d9a57bee2fac4c2de3f2fbb72a0..53a11181c05540a7e2f976ac9e7035b517e642b5 100644 (file)
@@ -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 ==
 
index 5fd34151dc653315c63dc2ffdc45f2caba1127fb..2c3b734b0510d1aa54d06c3bf3e7f021e2e72b16 100644 (file)
 
   <body>
     <h1>About Tahoe-LAFS</h1>
-    <p>Welcome to <a href="http://allmydata.org/trac/tahoe-lafs">the Tahoe-LAFS project</a>, a secure, decentralized, fault-tolerant filesystem. <a href="about.html">About Tahoe-LAFS.</a>
+    <p>Welcome to <a href="http://tahoe-lafs.org">the Tahoe-LAFS project</a>, a secure, decentralized, fault-tolerant filesystem. <a href="about.html">About Tahoe-LAFS.</a>
 
     <h1>How To Install Tahoe-LAFS</h1>
 
-    <p>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 <a href="http://allmydata.org/cgi-bin/mailman/listinfo/tahoe-dev">the tahoe-dev mailing list</a>, where friendly hackers will help you out.</p>
+    <p>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 <a href="http://allmydata.org/cgi-bin/mailman/listinfo/tahoe-dev">the tahoe-dev mailing list</a>, where friendly hackers will help you out.</p>
 
     <h2>Install Python</h2>
 
@@ -26,7 +26,7 @@
       <p>Download the 1.6.1 release zip file:</p>
 
       <pre><a
-      href="http://allmydata.org/source/tahoe/releases/allmydata-tahoe-1.6.1.zip">http://allmydata.org/source/tahoe/releases/allmydata-tahoe-1.6.1.zip</a></pre>
+      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</a></pre>
 
     <h2>Build Tahoe-LAFS</h2>
 
index de7437c713d9424c53e38450d381b51444b3c3ec..50ff45b9cf4eeda944dfa66ac365e3a4e2c98f62 100644 (file)
@@ -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
 
index 2b82bb6070ec9883cf16d919fba63afa1b7c3a02..6e639e0d7c96359c5ff54b7c2cb43e0aeb1966e8 100644 (file)
@@ -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):