Commit Graph

135 Commits

Author SHA1 Message Date
Jean-Paul Calderone 4626a09224 elaborate on reputation-based assumptions 2018-05-21 13:31:16 -04:00
Jean-Paul Calderone 931ffec005 semantic newlines 2018-05-21 13:31:10 -04:00
Jean-Paul Calderone d09b613d59 make mutable and immutable read the same 2018-05-18 15:45:22 -04:00
Jean-Paul Calderone f4b59b166d no more int-key mappings 2018-05-18 13:08:13 -04:00
Jean-Paul Calderone 3898911fcc consistent title levels 2018-05-18 13:07:18 -04:00
Jean-Paul Calderone f09ed91ab6 collapse these two APIs, they are the same
also add mutable .../shares listing
2018-05-18 13:01:57 -04:00
Jean-Paul Calderone 9388903515 need a way to advise of corrupt mutable shares 2018-05-18 13:01:45 -04:00
Jean-Paul Calderone c6a8e4535c mount this beneath the storage index resource 2018-05-18 13:01:19 -04:00
Jean-Paul Calderone 69195e0a5a maybe we don't even want Range 2018-05-18 13:01:10 -04:00
Jean-Paul Calderone 6c664d69a8 consistent non-abbreviation 2018-05-18 13:01:03 -04:00
Jean-Paul Calderone 9402698918 Harmonize hyphens 2018-05-18 11:11:04 -04:00
Jean-Paul Calderone 943b389d77 Banish slots and deemphasize buckets 2018-05-18 11:09:17 -04:00
Jean-Paul Calderone 3ef1ceeead markup 2018-05-18 09:13:57 -04:00
Jean-Paul Calderone dd78fe81d0 note the failure case 2018-05-18 09:05:46 -04:00
Jean-Paul Calderone fb51c1df40 correct the sample code 2018-05-18 09:05:37 -04:00
Jean-Paul Calderone 00ae3b5663 discuss encoded hash length 2018-05-18 09:05:25 -04:00
Jean-Paul Calderone d3f9ee2406 link to a different upload resume strategy 2018-05-17 15:09:50 -04:00
Jean-Paul Calderone 113af95984 when you are sending a range, you use Content-Range
when you are _asking_ for a range, you use Range
2018-05-17 15:08:03 -04:00
Jean-Paul Calderone 2bbe51a01d Discuss Range requests for uploads 2018-05-17 14:11:37 -04:00
Jean-Paul Calderone d011c2f936 rst twiddles 2018-05-17 14:11:32 -04:00
Jean-Paul Calderone eb9b44885e simple naming mistake
this must be a different endpoint or it is ambiguous with bucket
interactions.  plus it makes more sense that "place where storage
indexes are" is different from "place where buckets are" although I
am still uncomfortable with the idea that "storage indexes" are things
and not ... indexes ...
2018-05-17 14:01:46 -04:00
Jean-Paul Calderone 4e99f22c2b make containers plural I suppose 2018-05-17 14:01:36 -04:00
Jean-Paul Calderone 1d3f9715f8 trivial json markup fix 2018-05-17 14:01:18 -04:00
Jean-Paul Calderone 5fa71484e3 call out the base32/base64 mismatch 2018-05-16 10:16:58 -04:00
Jean-Paul Calderone 67ff44039f add values to the example 2018-05-16 09:49:58 -04:00
Jean-Paul Calderone 4bed6363a3 be specific about public key comparison 2018-05-16 09:49:48 -04:00
Jean-Paul Calderone 4ad5b5ab46 address slots 2018-05-15 16:00:40 -04:00
Jean-Paul Calderone c824bcd8b2 make the share a logical child of the bucket? 2018-05-15 15:28:03 -04:00
Jean-Paul Calderone 6d84cd8179 these are gone 2018-05-15 15:27:53 -04:00
Jean-Paul Calderone 178cb58a57 dunno how much the risk is elevated 2018-05-15 15:27:33 -04:00
Jean-Paul Calderone 6b72750397 reduce verticality 2018-05-15 15:27:26 -04:00
Jean-Paul Calderone 5f88cd0687 rework the security section 2018-05-15 15:16:01 -04:00
Jean-Paul Calderone 357820357c front matter 2018-05-15 15:04:20 -04:00
Jean-Paul Calderone 465489fd0b re-organize 2018-05-15 14:48:42 -04:00
Jean-Paul Calderone 23242266dc consistent style 2018-05-15 14:16:02 -04:00
Jean-Paul Calderone a3d4edca7d retrieve server version and info 2018-05-15 10:10:21 -04:00
Jean-Paul Calderone 73d903ad96 client-selected resource identifier -> PUT 2018-05-15 09:42:20 -04:00
Jean-Paul Calderone 5b35f591f1 write share data 2018-05-15 09:42:10 -04:00
Jean-Paul Calderone b6572e2856 clear now they are not necessarily consecutive 2018-05-15 09:41:45 -04:00
Jean-Paul Calderone 599bf074e3 more spurious indentation 2018-05-15 09:07:58 -04:00
Jean-Paul Calderone 8e9ba52118 spurious indentation 2018-05-15 09:07:07 -04:00
Jean-Paul Calderone 53dce7eafc first pass over read and write api 2018-05-14 15:58:21 -04:00
Jean-Paul Calderone c612fb7075 initial pass over security section 2018-05-14 14:30:34 -04:00
Jean-Paul Calderone b9939f7d4d link to inotify wikipedia page 2018-04-20 14:42:33 -04:00
meejah 0b25cad71e documentation fixups from daira's review 2018-02-06 15:28:02 -07:00
meejah 1171bf13af ticket #2882: preserve user mtime 2018-02-06 15:27:56 -07:00
Daira Hopwood 4723af6e2f LAFS now stands for "Least-Authority File Store" rather than "Least-Authority File System". refs #2345
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2017-06-06 11:20:49 +01:00
Brian Warner 91047bf828 docs: clean up .rst and references
This uses Read-The-Docs (sphinx/docutils) references exclusively, but adds a
README.md for GitHub viewers to remind them that the links there won't
work (closes ticket:2835).

It also fixes all the dangling references and other Sphinx warnings.

The "Preparation" section of docs/magic-folder-howto.rst was removed, since
this feature has since been merged to trunk.
2016-12-12 13:57:28 -08:00
Daira Hopwood 072d252245 Add multi-party-conflict-detection.rst.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -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
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 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
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 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
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
the real nejucomo d5f97cd74a Add a link in accounting-overview.txt to ticket #666. 2013-07-04 12:47:28 -07: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
david-sarah 07312870e1 Minor updates to URLs. 2012-03-13 20:28:53 +00:00
david-sarah 45dd8b910a docs: more formatting cleanups and corrections. Spell webapi and wapi as web-API. 2010-12-26 21:05:33 -08:00
david-sarah 5d612c87ab Update hyperlinks between docs, and linkify some external references. refs #1225 2010-12-11 21:14:59 -08:00
david-sarah 87f1bae7fe Add create-node CLI command, and make create-client equivalent to create-node --no-storage (fixes #760) 2010-01-15 21:20:55 -08:00
Shawn Willden 3782c27ac5 Lossmodel updates
Various improvements to the lossmodel, plus addition of README.lossmodel
that provides a link to the PDF.
2009-07-28 15:44:30 -07:00
Brian Warner 5501983f5f proposed/mutable-DSA.txt: add some new design criteria 2009-07-11 14:25:00 +01:00
Brian Warner 2c0f418cc0 add docs/proposed/GridID.txt (cleaning out some of my old branches) 2009-06-21 12:12:04 -07:00
Brian Warner 591d0fb5fb accounting-overview.txt: more edits 2009-05-23 12:03:59 -07:00
Brian Warner b94012ed05 accounting-overview.txt: small edits 2009-05-23 11:40:11 -07:00
Brian Warner 32250e0c06 docs/proposed: new Accounting overview, discuss in #666 2009-03-23 18:57:52 -07:00
Brian Warner 5f2f95a51e docs/proposed: move old accounting docs out of the way 2009-03-23 18:54:57 -07:00
Brian Warner b5d4972a7a move GC docs out of proposed/, since it's all implemented now. Add reference to configuration.txt . Add expire.*= suggestions to tahoe.cfg . 2009-03-23 16:08:20 -07:00
Brian Warner f0071c2571 expirer: clean up constructor args, add tahoe.cfg controls, use cutoff_date instead of date_cutoff 2009-03-18 18:00:09 -07:00
Brian Warner babcf632da util/time_format: new routine to parse dates like 2009-03-18, switch expirer to use it. I'd prefer to use 18-Mar-2009, but it is surprisingly non-trivial to build a parser that will take UTC dates instead of local dates 2009-03-18 17:58:14 -07:00
Brian Warner c7254c5f1d GC: add date-cutoff -based expiration, add proposed docs 2009-03-16 22:10:41 -07:00
Brian Warner ee956ffc7d lossmodel.lyx: move draft paper into docs/proposed/, since it's unfinished 2009-02-15 16:19:05 -07:00
Brian Warner ca32db5b39 #598: add cli+backupdb tests, improve user display, update docs, move docs out of proposed/ 2009-02-05 22:07:01 -07:00
Zooko O'Whielacronx 8610133d11 docs: proposed mutable file crypto design with ECDSA, 96-bit private keys, and semi-private keys (from http://allmydata.org/~zooko/lafs.pdf ) 2008-09-25 14:34:57 -07:00
Brian Warner 60ce491a79 add note to mutable-DSA.txt about the need for a ciphertext hash, for #492 2008-07-21 09:49:36 -07:00
Brian Warner 9bb05a7a08 docs/accounts-pubkey.txt: when sending FURLs (signed or otherwise), also send
the object that it references, to bypass the Foolscap getReferenceByName
roundtrip that would otherwise be required. Recipients must still use the
FURL for security, but pre-populating the foolscap table is a good speed-up.
2008-06-20 21:55:25 -07:00
Brian Warner 91565f465d docs: move files that are about future plans into docs/proposed/, to clearly separate them from descriptions of the present codebase 2008-06-02 23:07:02 -07:00