#1444 closed defect (fixed)

confusion between node and client/gateway in configuration.rst

Reported by: zooko Owned by: zooko@…
Priority: minor Milestone: undecided
Component: documentation Version: 1.8.2
Keywords: docs configuration usability reviewed Cc:
Launchpad Bug:

Description (last modified by zooko)

  • The 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 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 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:

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).

Attachments (1)

doc-1444.darcs.patch (38.1 KB) - added by davidsarah at 2011-08-12T16:55:17Z.
docs/configuration.rst: add section about the types of node, and clarify when setting web.port enables web-API service. refs #1444

Download all attachments as: .zip

Change History (7)

comment:1 Changed at 2011-07-26T18:17:35Z by zooko

  • Description modified (diff)

comment:2 Changed at 2011-07-28T04:21:14Z by zooko

  • Component changed from unknown to documentation
  • Owner changed from nobody to somebody

Changed at 2011-08-12T16:55:17Z by davidsarah

docs/configuration.rst: add section about the types of node, and clarify when setting web.port enables web-API service. refs #1444

comment:3 Changed at 2011-08-12T16:58:34Z by davidsarah

  • Keywords review-needed added
  • Owner somebody deleted

I'm not sure whether "client/server node" is a good term for a node that is not an introducer, stats gatherer or key generator; feedback needed on that.

comment:4 Changed at 2011-09-26T20:38:39Z by zooko

  • Keywords reviewed added; review-needed removed

comment:5 Changed at 2011-09-26T20:39:12Z by zooko

I committed a rebase of attachment:doc-1444.darcs.patch onto current trunk with some minor editing.

comment:6 Changed at 2011-09-26T20:39:28Z by zooko@…

  • Owner set to zooko@…
  • Resolution set to fixed
  • Status changed from new to closed

In 3a14ad1bb18e741f:

docs/configuration.rst: add section about the types of node, and clarify when setting web.port enables web-API service. fixes #1444

Note: See TracTickets for help on using tickets.