tahoe-lafs/trac-2024-07-25
2
0
Issues 1.1k Wiki Activity

stale doc files #421

New issue
Closed
opened 2008-05-29 22:27:27 +00:00 by zooko · 8 comments
zooko commented 2008-05-29 22:27:27 +00:00
Owner
Copy link

I've been noticing stale doc files or wiki pages. Here is a partial list. I'd like to go through these and either delete them, update them, or replace them with a reference to the new replacement doc.

I've been noticing stale doc files or wiki pages. Here is a partial list. I'd like to go through these and either delete them, update them, or replace them with a reference to the new replacement doc. * [FileEncoding](wiki/FileEncoding) on [the Doc page](wiki/Doc) * [ShareEncoding](wiki/ShareEncoding) on [the Doc page](wiki/Doc) * [PeerSelection](wiki/PeerSelection) on [the Doc page](wiki/Doc) * [ChangingFilesWhileCopyingThem](wiki/ChangingFilesWhileCopyingThem) on [the Doc page](wiki/Doc) * source:docs/install-details.html and source:README.w32 has lots of carefully gathered notes about building and installing on various platforms, but some of it may be obsolete, and all of it is very badly formatted and organized * source:roadmap.txt
tahoe-lafs added the
documentation
major
defect
1.0.0
 labels 2008-05-29 22:27:27 +00:00
tahoe-lafs added this to the 1.1.0 milestone 2008-05-29 22:27:27 +00:00
warner commented 2008-05-29 22:47:42 +00:00
Author
Owner
Copy link

I will remove the first four docs (FileEncoding, ShareEncoding, PeerSelection, and ChangingFilesWhileCopyingThem) from the wiki pages, and put their contents (whatever remains accurate and relevant) into the source tree in source:docs

We're going to try to put long-term docs in the source tree, and use the mailing list for discussions (rather than using wiki pages for discussions).

I will remove the first four docs (FileEncoding, [ShareEncoding](wiki/ShareEncoding), [PeerSelection](wiki/PeerSelection), and [ChangingFilesWhileCopyingThem](wiki/ChangingFilesWhileCopyingThem)) from the wiki pages, and put their contents (whatever remains accurate and relevant) into the source tree in source:docs We're going to try to put long-term docs in the source tree, and use the mailing list for discussions (rather than using wiki pages for discussions).
warner commented 2008-05-29 22:48:22 +00:00
Author
Owner
Copy link

docs/install-details.html and README.w32 are now covered by #194, and are removed from this ticket.

docs/install-details.html and README.w32 are now covered by #194, and are removed from this ticket.
warner commented 2008-05-29 22:50:57 +00:00
Author
Owner
Copy link

I will make sure there is a ticket present for everything in roadmap.txt, and then delete roadmap.txt

I will make sure there is a ticket present for everything in roadmap.txt, and then delete roadmap.txt
warner commented 2008-05-30 00:53:38 +00:00
Author
Owner
Copy link

Hm, it's actually kind of nice to have the HTML docs for this stuff, because
then the pictures and the text are on the same page.

Having the docs in source:docs/ makes them more likely to be updated, though.
I'll start by updating the docs in the wiki.

What needs updating:

  • FileEncoding: we no longer use a fileid. When CHK is used, the encryption
    key is computed with a convergence secret, and we use SHA-256d. The
    encryption key can also be random instead of using CHK. The "verifierid"
    is actually the flat ciphertext hash, which is a small (and optional)
    component of the UEB block. Encoding and share merkle trees work as
    described.
  • ShareEncoding: this is actually just a placeholder for a link to a FEC
    page, and should be moved to the [Bibliography]Bibliography
  • PeerSelection: this page is still accurate. The PeerSelection/TahoeTwo
    page that it points to needs small updates (but should be moved to
    source:docs/): replace "verifierid" with "storage index".
  • ChangingFilesWhileCopyingThem: this just captures some early design
    discussion. I'll turn this into a ticket.
  • roadmap.txt: this should be split into individual tickets, and the
    file then removed from the source tree
Hm, it's actually kind of nice to have the HTML docs for this stuff, because then the pictures and the text are on the same page. Having the docs in source:docs/ makes them more likely to be updated, though. I'll start by updating the docs in the wiki. What needs updating: * [FileEncoding](wiki/FileEncoding): we no longer use a fileid. When CHK is used, the encryption key is computed with a convergence secret, and we use SHA-256d. The encryption key can also be random instead of using CHK. The "verifierid" is actually the flat ciphertext hash, which is a small (and optional) component of the UEB block. Encoding and share merkle trees work as described. * [ShareEncoding](wiki/ShareEncoding): this is actually just a placeholder for a link to a FEC page, and should be moved to the [Bibliography]Bibliography * [PeerSelection](wiki/PeerSelection): this page is still accurate. The [PeerSelection](wiki/PeerSelection)/TahoeTwo page that it points to needs small updates (but should be moved to source:docs/): replace "verifierid" with "storage index". * [ChangingFilesWhileCopyingThem](wiki/ChangingFilesWhileCopyingThem): this just captures some early design discussion. I'll turn this into a ticket. * roadmap.txt: this should be split into individual tickets, and the file then removed from the source tree
warner commented 2008-05-30 01:12:49 +00:00
Author
Owner
Copy link

ShareEncoding: removed
ChangingFilesWhileCopyingThem: turned into ticket #427

PeerSelection: actually, this could be useful from a historical perspective: it explains paths we didn't go down. Should such things be put into source:docs ? Or on a wiki page?

[ShareEncoding](wiki/ShareEncoding): removed [ChangingFilesWhileCopyingThem](wiki/ChangingFilesWhileCopyingThem): turned into ticket #427 [PeerSelection](wiki/PeerSelection): actually, this could be useful from a historical perspective: it explains paths we didn't go down. Should such things be put into source:docs ? Or on a wiki page?
warner commented 2008-06-03 01:44:11 +00:00
Author
Owner
Copy link

ok, PeerSelection is gone, and moved into the source tree in source:docs/historical/

ok, [PeerSelection](wiki/PeerSelection) is gone, and moved into the source tree in source:docs/historical/
warner commented 2008-06-03 03:00:07 +00:00
Author
Owner
Copy link

and FileEncoding is gone. The only thing left to this ticket is roadmap.txt .

and [FileEncoding](wiki/FileEncoding) is gone. The only thing left to this ticket is roadmap.txt .
warner commented 2008-06-03 05:30:25 +00:00
Author
Owner
Copy link

..and roadmap.txt is gone, split into a bunch of separate tickets (mostly in the #444 to #451 range). This ticket is now done.

..and roadmap.txt is gone, split into a bunch of separate tickets (mostly in the #444 to #451 range). This ticket is now done.
tahoe-lafs added the
fixed
 label 2008-06-03 05:30:25 +00:00
warner closed this issue 2008-06-03 05:30:25 +00:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
No results found.
No results found.
Labels
Clear labels   
0.2.0

   
0.3.0

   
0.4.0

   
0.5.0

   
0.5.1

   
0.6.0

   
0.6.1

   
0.7.0

   
0.8.0

   
0.9.0

   
1.0.0

   
1.1.0

   
1.10.0

   
1.10.1

   
1.10.2

   
1.10a2

   
1.11.0

   
1.12.0

   
1.12.1

   
1.13.0

   
1.14.0

   
1.15.0

   
1.15.1

   
1.2.0

   
1.3.0

   
1.4.1

   
1.5.0

   
1.6.0

   
1.6.1

   
1.7.0

   
1.7.1

   
1.7β

   
1.8.0

   
1.8.1

   
1.8.2

   
1.8.3

   
1.8β

   
1.9.0

   
1.9.0-s3branch

   
1.9.0a1

   
1.9.0a2

   
1.9.0b1

   
1.9.1

   
1.9.2

   
1.9.2a1

   
LeastAuthority.com automation

   
blocker

   
cannot reproduce

   
cloud-branch

   
code

catch-all for anything that can be fixed by writing code but isn't classified better

  
code-dirnodes

anything involving tahoe directories

  
code-encoding

immutable-file encoding format/layout, cap format, encoding/decoding algorithms

  
code-frontend

general frontend things: new user-facing interfaces, FTP/SFTP servers, FUSE-like interfaces

  
code-frontend-cli

CLI tools

  
code-frontend-ftp-sftp

   
code-frontend-magic-folder

   
code-frontend-web

webapi interfaces, user-facing "WUI" interfaces

  
code-mutable

anything involving mutable files: encoding/decoding, share format

  
code-network

Introducer, locating storage servers, establishing/maintaining connections to them

  
code-nodeadmin

node startup/shutdown, tools to create nodes, logging tools, management/monitoring tools, manhole, disk-space-limiting tools

  
code-peerselection

server selection/sorting algorithm, rebalancing code, allocation policy, swarming-download

  
code-storage

storage-server implementation, share-storage directory layout, client-to-server share transfer protocol

  
contrib

problems with non-core things that live in the source:contrib/ directory

  
critical

   
defect

   
dev-infrastructure

things that help us build Tahoe: buildbot, automated speed/memory/code-coverage tests and results-displayers, IRC channels, mailing lists, this Trac instance

  
documentation

docs items. Also use 'docs' keyword on tickets in more specific components.

  
duplicate

   
enhancement

   
fixed

   
invalid

   
major

   
minor

   
n/a

   
normal

   
operational

things involved in running a tahoe grid, external tools to monitor/maintain a grid (like "nodeadmin" but larger-scale). Was also used for issues with the allmydata.com grid.

  
packaging

setup.py script, library dependencies, binary packages, licensing, installation instructions

  
somebody else's problem

   
supercritical

   
task

   
trivial

   
unknown

Uncategorized. All tickets default to this component until someone updates it.

  
was already fixed

   
website

things about the tahoe-lafs.org website (and sometimes this Trac instance, shared with 'dev-infrastructure')

  
wontfix

   
worksforme
No labels
0.2.0
0.3.0
0.4.0
0.5.0
0.5.1
0.6.0
0.6.1
0.7.0
0.8.0
0.9.0
1.0.0
1.1.0
1.10.0
1.10.1
1.10.2
1.10a2
1.11.0
1.12.0
1.12.1
1.13.0
1.14.0
1.15.0
1.15.1
1.2.0
1.3.0
1.4.1
1.5.0
1.6.0
1.6.1
1.7.0
1.7.1
1.7β
1.8.0
1.8.1
1.8.2
1.8.3
1.8β
1.9.0
1.9.0-s3branch
1.9.0a1
1.9.0a2
1.9.0b1
1.9.1
1.9.2
1.9.2a1
LeastAuthority.com automation
blocker
cannot reproduce
cloud-branch
code
code-dirnodes
code-encoding
code-frontend
code-frontend-cli
code-frontend-ftp-sftp
code-frontend-magic-folder
code-frontend-web
code-mutable
code-network
code-nodeadmin
code-peerselection
code-storage
contrib
critical
defect
dev-infrastructure
documentation
duplicate
enhancement
fixed
invalid
major
minor
n/a
normal
operational
packaging
somebody else's problem
supercritical
task
trivial
unknown
was already fixed
website
wontfix
worksforme
Milestone
Clear milestone
No items
No milestone
1.1.0
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: tahoe-lafs/trac-2024-07-25#421
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?