Commit Graph

868 Commits

Author SHA1 Message Date
c582a21e99 webapi.rst: fixups
Re-indent the blocks for consistency, improve the explanation of
?filename=foo.jpg to match it's new location, use new-style reference
for urls-and-utf8 footnote.
2016-04-22 19:23:49 -07:00
3e7346100f update webapi.rst's View/Download File docs
• mark "/file/" as a synonym for "/named/" to be deprecated (fixes #1903)
• move the options common to all three forms to the bottom and dedent them
• name the protocol/format as "LAFS" and the implementation/client "Tahoe"
• reflow (with fill-column 77)
2016-04-22 19:17:22 -07:00
23f871a409 add [test] "extra" to install testing-only dependencies
closes ticket:2776
2016-04-12 12:32:46 -07:00
8279d919f3 remove "manhole" (ssh-accessible REPL)
This little-used debugging feature allowed you to SSH or Telnet "into" a
Tahoe node, and get an interactive Read-Eval-Print-Loop (REPL) that
executed inside the context of the running process. The SSH
authentication code used a deprecated feature of Twisted, this code had
no unit-test coverage, and I haven't personally used it in at least 6
years (despite writing it in the first place). Time to go.

Also experiment with a Twisted-style "topfiles/" directory of NEWS
fragments. The idea is that we require all user-visible changes to
include a file or two (named as $TICKETNUM.$TYPE), and then run a script
to generate NEWS during the release process, instead of having a human
scan the commit logs and summarize the changes long after they landed.

Closes ticket:2367
2016-04-06 13:40:06 -10:00
431d762872 desert-island: new approach, works better 2016-03-31 17:12:08 -07:00
2b5633eedb relnotes, docs: post-release fixups 2016-03-30 17:27:44 -07:00
3b0789fb0c docs: update release checklist 2016-03-30 16:03:52 -07:00
1199a1547f INSTALL: update downloads URL to expected location 2016-03-30 02:51:49 -07:00
ab091e68de update relnotes and known_issues 2016-03-30 02:25:27 -07:00
c674b55918 docs: switch to default readthedocs.org theme 2016-03-30 02:18:00 -07:00
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
248a6ceade docs: add .empty to preserve empty _static and _templates 2016-03-30 01:26:47 -07:00
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
142185bb86 docs: add sphinx index.rst, improve headers 2016-03-29 21:46:11 -07:00
0acc1dc079 docs: run sphinx-quickstart, move old Makefile
* .gitignore: add docs/_build (sphinx output directory)
2016-03-29 21:02:14 -07:00
2cfe2eb566 INSTALL.rst: more tweaks 2016-03-29 21:01:22 -07:00
1f1e10d59b docs/OS-X: the $PATH *does* get added correctly 2016-03-28 01:37:35 -07:00
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
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
a63263dc55 minor docs tweaks 2016-03-25 19:25:55 -07:00
ef1759046d rewrite docs, with pip and virtualenv 2016-03-25 19:22:03 -07:00
090b592ff8 docs: rename quickstart to INSTALL 2016-03-25 18:26:54 -07:00
439eaf8c9d preliminary windows docs 2016-03-25 17:27:38 -07:00
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
17886c51aa add docs/desert-island.rst
refs ticket:2752
2016-03-22 18:18:49 -07:00
a8b3c40f46 docs/donations: announce new BTC key, governance+accounting 2016-03-21 01:20:26 -07:00
136c16e5ec docs: explain what the OS-X package does and does not provide. 2016-03-16 12:38:26 -07:00
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
a7894a8507 edit for accuracy 2016-03-13 14:34:31 +00:00
57cc4e919d edit for readability 2016-03-13 14:32:46 +00:00
71c62b3256 docs/quickstart.rst: mention that py2.6 no longer works 2016-01-28 13:13:44 -08:00
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
b5222e3679 Merge pull request #204 from leif/preferred_peers-rebased3
new feature: preferred storage servers
2015-12-04 18:01:30 +00:00
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
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
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
a6dd94646e Move manpage into a heirarchical man1 path.
Author: Ramakrishnan Muthukrishnan <ram@leastauthority.com>
2015-09-03 15:18:58 +01:00
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
befa4babea update docs for 1.10.2 release 2015-07-30 19:36:45 -07:00
4bb12887f4 quickstart: Mention python-dev package for Python.h
Closes ticket:2328.
2015-07-28 17:47:09 -07:00
259ba07a5e improve HTTP byte-range docs 2015-07-28 13:28:36 -07:00
c3608f61d9 webapi.rst: document Range: header on GET requests
closes ticket#2460
2015-07-28 13:15:50 -07:00
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
e03bae7948 docs/how-to-release: add more wiki pages to update 2015-06-26 18:39:29 -07:00
aeafbc0dd1 release checklist: use signed git tag next time 2015-06-15 18:35:55 -07:00
5887029b17 update docs for 1.10.1 release 2015-06-15 16:29:37 -07:00
1105278589 Finish user-interface.rst. fixes ticket:2443
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-06-11 21:33:47 +01:00
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
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
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