ooni-probe-cli/docs/design
Simone Basso 5ebdeb56ca
feat: tlsping and tcpping using step-by-step (#815)
## Checklist

- [x] I have read the [contribution guidelines](https://github.com/ooni/probe-cli/blob/master/CONTRIBUTING.md)
- [x] reference issue for this pull request: https://github.com/ooni/probe/issues/2158
- [x] if you changed anything related how experiments work and you need to reflect these changes in the ooni/spec repository, please link to the related ooni/spec pull request: https://github.com/ooni/spec/pull/250

## Description

This diff refactors the codebase to reimplement tlsping and tcpping
to use the step-by-step measurements style.

See docs/design/dd-003-step-by-step.md for more information on the
step-by-step measurement style.
2022-07-01 12:22:22 +02:00
..
dd-001-oonimkall.md doc: publish the step-by-step design document (#814) 2022-06-14 14:38:29 +02:00
dd-002-netx.md doc: publish the step-by-step design document (#814) 2022-06-14 14:38:29 +02:00
dd-003-step-by-step.md feat: tlsping and tcpping using step-by-step (#815) 2022-07-01 12:22:22 +02:00
README.md doc: publish the step-by-step design document (#814) 2022-06-14 14:38:29 +02:00

Design documents

This directory contains ooni/probe-cli design documents. We generally use issues as short design documents, but some more-complex discussions require proper design documents. We started collecting existing design documents into this repository on 2022-06-13, to provide additional clarity regarding our more-complex choices.

Implementation aspects may change freely over time and there's no need to rush back and update the related design document. We want to keep a design document around to document the why of specific choices. Most design documents are, therefore, informational and historic by nature, given that we do not aim to continuously update them.

Rather than radically revamp a design document in case of radical direction changes, it is advisable to create a new design document referencing the previous design document and explaining what changed.