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

rearrange docs 

[Imported from Trac: page Doc, version 102]
zooko 2012-09-04 19:15:25 +00:00
parent 5d14f27f56
commit eac654747e
1 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
Doc.md

@ -2,15 +2,18 @@
There are two collections of documents for users. One collection is made up of pages on this wiki, and the other is made up of files in the 'docs' directory of the Tahoe-LAFS source tree. There are two collections of documents for users. One collection is made up of pages on this wiki, and the other is made up of files in the 'docs' directory of the Tahoe-LAFS source tree.
Note: these links are to the 'trunk' (latest) versions of the documentation. See the 'docs' directory of a Tahoe-LAFS release for docs relating to that version. ## first steps
## User Docs, on the wiki
* [about]source:docs/about.rst: the Tahoe-LAFS filesystem and the unique properties that it offers * [about]source:docs/about.rst: the Tahoe-LAFS filesystem and the unique properties that it offers
* [quickstart]source:docs/quickstart.rst: how to get the software and set it up * [quickstart]source:docs/quickstart.rst: how to get the software and set it up
* [running]source:docs/running.rst: how to run it once it is set up * [running]source:docs/running.rst: how to run it once it is set up
## User Docs, on the wiki
Note: these links are to the 'trunk' (latest) versions of the documentation. See the 'docs' directory of a Tahoe-LAFS release for docs relating to that version.
* [Public Test Grid](TestGrid): an existing grid to use for testing your installation * [Public Test Grid](TestGrid): an existing grid to use for testing your installation
* [Known Issues]source:docs/known_issues.rst: things you need to be aware of if you want to rely on Tahoe-LAFS to store your valuable data.
* [How To Report A Bug](HowToReportABug): We love bug reports! Here's how. * [How To Report A Bug](HowToReportABug): We love bug reports! Here's how.
* [The story of a file](http://bigasterisk.com/tahoe-playground), interactive illustration by Drew Perttula. * [The story of a file](http://bigasterisk.com/tahoe-playground), interactive illustration by Drew Perttula.
@ -21,21 +24,25 @@ Note: these links are to the 'trunk' (latest) versions of the documentation. See
* [SFTP Frontend](SftpFrontend): compatibility issues for accessing Tahoe-LAFS via SFTP * [SFTP Frontend](SftpFrontend): compatibility issues for accessing Tahoe-LAFS via SFTP
* [Tips & Tricks](TipsTricks) * [Tips & Tricks](TipsTricks)
* [Capabilities](Capabilities) what are capabilities; the different kinds that we currently use
## User Docs, in source code ## User Docs, in source code
* [the 'docs' directory]source:docs/ * [the 'docs' directory]source:docs/
## A Glance Under The Hood or "Gee What Does This Button Do?"
* [configuration]source:trunk/docs/configuration.rst: a description of the contents of your ".tahoe" directory * [configuration]source:trunk/docs/configuration.rst: a description of the contents of your ".tahoe" directory
* [architecture]source:trunk/docs/architecture.rst: a succinct overview of the whole system * [architecture]source:trunk/docs/architecture.rst: a succinct overview of the whole system
* [Command Line Interface]source:trunk/docs/frontends/CLI.rst: the basic "how to" for the CLI * [Command Line Interface]source:trunk/docs/frontends/CLI.rst: the basic "how to" for the CLI
* [Web API]source:trunk/docs/frontends/webapi.rst: the basic "how to" for the WAPI * [Web API]source:trunk/docs/frontends/webapi.rst: the basic "how to" for the WAPI
* [Capabilities](Capabilities) what are capabilities; the different kinds that we currently use
* [Known Issues]source:docs/known_issues.rst: things you need to be aware of if you want to rely on Tahoe-LAFS to store your valuable data.
## Developer Docs
* [Developer Docs](Dev#DeveloperDocs)
## See Also ## See Also
* [The Dev page](Dev) for Tahoe-LAFS hackers has more detailed technical documentation.
* [The [RelatedProjects](RelatedProjects) page](RelatedProjects) extensions to Tahoe-LAFS, integrations of Tahoe-LAFS into your favorite other tools, and links to a few other decentralized storage projects that you might be interested in. * [The [RelatedProjects](RelatedProjects) page](RelatedProjects) extensions to Tahoe-LAFS, integrations of Tahoe-LAFS into your favorite other tools, and links to a few other decentralized storage projects that you might be interested in.
* [The News page](News) has sources of news and information. * [The News page](News) has sources of news and information.
* [The Bibliography page](Bibliography) contains links to scientific papers of interest.
## The Parade of Release Notes ## The Parade of Release Notes