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

Document new API #3690

New issue
Closed
opened 2021-05-02 19:12:48 +00:00 by maylee · 5 comments
maylee commented 2021-05-02 19:12:48 +00:00
Owner
Copy link

The documentation at /docs/frontends/webapi.rst needs to be deleted or rewritten after we replace the current API.

The documentation at `/docs/frontends/webapi.rst` needs to be deleted or rewritten after we replace the current API.
tahoe-lafs added the
documentation
normal
defect
n/a
 labels 2021-05-02 19:12:48 +00:00
tahoe-lafs added this to the User Documentation Goals milestone 2021-05-02 19:12:48 +00:00
exarkun commented 2021-05-02 23:32:38 +00:00
Author
Owner
Copy link

What problem would this rewrite address?

Also, the API it describes is bad and we should replace it with a new, different one.

What problem would this rewrite address? Also, the API it describes is bad and we should replace it with a new, different one.
maylee commented 2021-05-03 08:49:24 +00:00
Author
Owner
Copy link

With that in mind, this rewrite can hold off until the API is replaced, and it would really be documentation for the new API. At any rate, whatever's at /docs/frontends/webapi.rst needs to be changed.

Ticket has been changed to reflect this perspective.

With that in mind, this rewrite can hold off until the API is replaced, and it would really be documentation for the new API. At any rate, whatever's at `/docs/frontends/webapi.rst` needs to be changed. Ticket has been changed to reflect this perspective.
tahoe-lafs changed title from Edit Web API documentation to Document new API 2021-05-03 08:49:24 +00:00
exarkun commented 2021-05-03 11:07:14 +00:00
Author
Owner
Copy link

A better development workflow might be that every incremental implementation effort on the new API (which will certainly not be merged as a single, fully-formed thing) comes along with its own new chunk of documentation.

If so, the tickets we want are probably more like "New API for XXX" where "XXX" is stuff like "upload a file", "download a file", etc (these are examples; the new API hasn't been given much dedicated thought yet).

A better development workflow might be that every incremental implementation effort on the new API (which will certainly not be merged as a single, fully-formed thing) comes along with its own new chunk of documentation. If so, the tickets we want are probably more like "New API for XXX" where "XXX" is stuff like "upload a file", "download a file", etc (these are examples; the new API hasn't been given much dedicated thought yet).
maylee commented 2021-05-04 18:12:12 +00:00
Author
Owner
Copy link

Noted, can we keep this ticket in place until those API changes take place?

Noted, can we keep this ticket in place until those API changes take place?
exarkun commented 2021-05-11 15:19:12 +00:00
Author
Owner
Copy link

If it were just me, I'd close this. All documentation should be delivered alongside (and at the same time as) the implementation.

If it were just me, I'd close this. All documentation should be delivered alongside (and at the same time as) the implementation.
tahoe-lafs added the
wontfix
 label 2021-05-11 15:25:47 +00:00
maylee closed this issue 2021-05-11 15:25:47 +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
User Documentation Goals
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#3690
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?