Opened 9 years ago

Closed 6 years ago

Last modified 6 years ago

#1606 closed task (fixed)

Write a BridgeDB spec

Reported by: phobos Owned by: nickm
Priority: Medium Milestone:
Component: Circumvention/BridgeDB Version:
Severity: Keywords: important
Cc: arma, sysrqb, isis Actual Points:
Parent ID: #4380 Points:
Reviewer: Sponsor:

Description

Write a BridgeDB spec

Child Tickets

Change History (19)

comment:1 Changed 9 years ago by nickm

Does this belong under "Distribution" or under a new "BridgeDB" category?

comment:2 Changed 9 years ago by phobos

Component: Tor - DistributionTor - BridgeDB

comment:3 Changed 9 years ago by nickm

Owner: set to nickm
Status: newassigned

Hm. Should this be a spec for the bridgedb behavior, or for how the implementation works? Both, probably. I'm probably the logical person to do this.

comment:4 Changed 9 years ago by arma

Both, right.

I really want the spec for its behavior, so I can propose changes to the behavior.

Whereas I imagine kaner and Aaron want some tips on how the implementation works.

comment:5 Changed 9 years ago by karsten

Status: assignedneeds_review

Branch spec in my public BridgeDB repository has a first draft of a spec, plus a couple of comments/questions.

comment:6 Changed 9 years ago by nickm

Added some text and answered some questions in branch "spec" in my public bridgedb repo. Back over to you, karsten. ;)

comment:7 in reply to:  6 Changed 9 years ago by karsten

Replying to nickm:

Added some text and answered some questions in branch "spec" in my public bridgedb repo. Back over to you, karsten. ;)

Thanks for the feedback! I'll work on the spec some more on the flight tomorrow.

comment:8 Changed 8 years ago by karsten

And by "tomorrow" I meant 8 weeks later. Sorry for the delay.

Please find the updated branch "spec" in my public repository. It's not perfect, but I think I fixed a few things.

comment:9 Changed 8 years ago by nickm

looks good to me; I'd say merge it. We can clean up remaining issues as we go.

comment:10 Changed 8 years ago by karsten

Cc: arma added

Sounds good! Merging what we have as a first draft. I'll keep this ticket open to discuss the remaining issues until we think the spec is "done."

Adding arma to Cc, because he wanted to have a look at the first draft once it's there.

comment:11 Changed 8 years ago by karsten

Milestone: BridgeDB Upgrades Phase 1
Parent ID: #4380

Assigning as a child ticket to the project ticket that replaces the "BridgeDB Upgrades Phase 1" milestone.

comment:12 Changed 6 years ago by sysrqb

Cc: Matthew.Finkel@… added
Keywords: important added

comment:13 Changed 6 years ago by sysrqb

Improvements, updates, clarifications, etc. This should bring the spec/implementation description inline with the current implementation.

Branch bug1606_spec_update_rebased on https://github.com/sysrqb/bridgedb.git

comment:14 in reply to:  13 Changed 6 years ago by sysrqb

Replying to sysrqb:

Branch bug1606_spec_update_rebased on https://github.com/sysrqb/bridgedb.git

I should probably note that this is now in my public repo, too.

comment:15 Changed 6 years ago by sysrqb

Added a description of how we decide the number of bridges to return to a user, a good suggestion by asn. Branch bug1606_spec_update_rebased_r1.

comment:16 Changed 6 years ago by sysrqb

Cc: sysrqb isis added; Matthew.Finkel@… removed

comment:17 Changed 6 years ago by isis

Resolution: fixed
Status: needs_reviewclosed

I rebased sysrqb's bug1606_spec_update_rebased_r1 on top of my develop branch, it's named fix/1606-based-on_bug1606_spec_update_rebased_r1. It has a couple extra additions to bridge-db-spec.txt, and then I moved bridge-db-spec.txt and xxx-bridgedb-learns-ipv6.txt into the doc/ directory. I've merged this into develop (under the assumption that it's okay to merge things that are only doc changes).

comment:18 Changed 6 years ago by isis

I imported the git history of the bridgedb.git:/doc/bridge-db-spec.txt file into my torspec repo at torspec.git:/bridgedb-spec.txt. From now on, it's probably easier to make additional changes in torspec.git.

comment:19 Changed 6 years ago by nickm

I've merged isis's bridgedb/1606-bridgedb-spec branch to torspec.

Note: See TracTickets for help on using tickets.