#29149 closed defect (fixed)

Update/improve documentation on how the scanner/generator work

Reported by: juga Owned by: juga
Priority: Medium Milestone: sbws: 1.0.x-final
Component: Core Tor/sbws Version: sbws: 1.0.2
Severity: Normal Keywords: easy
Cc: Actual Points: 1
Parent ID: Points: 1
Reviewer: asn Sponsor:

Description

Currently, the main documentation about sbws works is https://sbws.readthedocs.io/en/latest/specification.html, but it's not updated.
There's also no documentation about what the main functions (run_speed_test and DestinationList).
It'd also be useful to document how the threads work.

Child Tickets

Change History (10)

comment:1 Changed 21 months ago by juga

Assigned to milestone 1.0, since would be useful to have this documentation before the hackweek and would help operators to understand what sbws is doing.

comment:2 Changed 21 months ago by atagar

Component: Core Tor/StemCore Tor/sbws

Hi juga, I suspect assigning this to stem was a misclick. Happy to chat though if you really meant to send this my way.

comment:3 Changed 21 months ago by juga

Yes, it was a misclick, thanks for fixing it.

comment:4 Changed 21 months ago by juga

Keywords: easy added
Points: 1
Status: assignedneeds_review

https://github.com/torproject/sbws/pull/334

It only modifies documentation. It'll be merged in 1 week if it's not reviewed by then.

comment:5 Changed 21 months ago by juga

Status: needs_reviewneeds_revision

Changing to revise since i thought to include all documentation used in the hackweek.

comment:6 Changed 21 months ago by juga

Summary: Document technical overview on how sbws worksUpdate/improve documentation on how the scanner/generator work

comment:7 Changed 21 months ago by juga

Status: needs_revisionneeds_review

Added more documentation from the hackweek presentation (https://juga0.github.io/tor_hackweek_bandwidth_slides/).

comment:8 Changed 20 months ago by dgoulet

Reviewer: asn

comment:9 Changed 20 months ago by asn

Status: needs_reviewmerge_ready

LGTM! That's great documentation.

Perhaps you can also squash some of the commits together so that the history is simpler.

comment:10 Changed 20 months ago by juga

Actual Points: 1
Resolution: fixed
Status: merge_readyclosed

Merged.

Note: See TracTickets for help on using tickets.