[tahoe-lafs-trac-stream] [tahoe-lafs] #1444: confusion between node and client/gateway in configuration.rst

[tahoe-lafs]

#1444: confusion between node and client/gateway in configuration.rst
-------------------------+------------------------------------------
     Reporter:  zooko    |      Owner:  nobody
         Type:  defect   |     Status:  new
     Priority:  minor    |  Milestone:  undecided
    Component:  unknown  |    Version:  1.8.2
   Resolution:           |   Keywords:  docs configuration usability
Launchpad Bug:           |
-------------------------+------------------------------------------
Description changed by zooko:

Old description:

> * The [http://tahoe-lafs.org/trac/tahoe-
> lafs/browser/trunk/docs/configuration.rst?annotate=blame&rev=5034#L72
> description of "web.port"] assumes that the node is running a
> client/gateway. This should be amended to say something like "providing
> node status and, if the node is running a storage client a.k.a. gateway
> service, providing filesystem access as defined in `webapi.rst
> <frontends/webapi.rst>`_".
>
>  * The docs in [source:docs/configuration.rst] should be edited a little
> to explain that the thing called a "Tahoe-LAFS storage client" is also
> sometimes called a "Tahoe-LAFS gateway".
>
>  * The [http://tahoe-lafs.org/trac/tahoe-
> lafs/browser/trunk/docs/configuration.rst?annotate=blame&rev=5034#L57
> docs of the node section] should include mention of a storage server and
> helper as kinds of nodes, in addition to storage client and introducer.
>
> In addition, I think the following is a related issue:
>
>  * As far as I can tell, the {{{tempdir}}} field from [http://tahoe-
> lafs.org/trac/tahoe-
> lafs/browser/trunk/docs/configuration.rst?annotate=blame&rev=5034#L51 the
> "node" section] of the configuration file belongs in [http://tahoe-
> lafs.org/trac/tahoe-
> lafs/browser/trunk/docs/configuration.rst?annotate=blame&rev=5034#L252
> the "client" section], because a temp directory for uploading files is
> only used for clients/gateways.
>
> But since fixing that will require an actual code change and not just a
> documentation change I'll put it in a separate ticket.

New description:

 * The [http://tahoe-lafs.org/trac/tahoe-
 lafs/browser/trunk/docs/configuration.rst?annotate=blame&rev=5034#L72
 description of "web.port"] assumes that the node is running a
 client/gateway. This should be amended to say something like "providing
 node status and, if the node is running a storage client a.k.a. gateway
 service, providing filesystem access as defined in `webapi.rst
 <frontends/webapi.rst>`_".

  * The docs in [source:docs/configuration.rst] should be edited a little
 to explain that the thing called a "Tahoe-LAFS storage client" is also
 sometimes called a "Tahoe-LAFS gateway".

  * The [http://tahoe-lafs.org/trac/tahoe-
 lafs/browser/trunk/docs/configuration.rst?annotate=blame&rev=5034#L57 docs
 of the node section] should include mention of a storage server and helper
 as kinds of nodes, in addition to storage client and introducer.

 In addition, I think the following is a related issue:

  * As far as I can tell, the {{{tempdir}}} field from [http://tahoe-
 lafs.org/trac/tahoe-
 lafs/browser/trunk/docs/configuration.rst?annotate=blame&rev=5034#L51 the
 "node" section] of the configuration file belongs in [http://tahoe-
 lafs.org/trac/tahoe-
 lafs/browser/trunk/docs/configuration.rst?annotate=blame&rev=5034#L252 the
 "client" section], because a temp directory for uploading files is only
 used for clients/gateways.

 But since fixing that will require an actual code change and not just a
 documentation change I'll put it in a separate ticket (#1445).

--

-- 
Ticket URL: <http://tahoe-lafs.org/trac/tahoe-lafs/ticket/1444#comment:1>
tahoe-lafs <http://tahoe-lafs.org>
secure decentralized storage