spec README

The project's README from github.com/ooni/spec. As one markdown file: README.md.

OONI Spec

The OONI testing methodology is openly specified as part of OONI Spec. This includes all the experiments that we run, the backend components used as part of test and the data formats.

The way in which we do these specifications is similar to the RFC (Request For Comments) process.

This makes it possible to have a deep understanding of how OONI tests work, explain the assumption we make in them and make it possible to create independent implementations.

To get an introduction of how we operate from the point of view of OONI Probe, i.e. the software that users can install, please see the specific documentation describing that. New developers would ideally want to be familiar with this document to understand the context.

Terminology

Nettests (aka experiments)

Are network experiments that deliver some meaningful results to end users. See the nettests directory.

OONI Probe (aka the Probe)

The software that users run to perform nettests. See the probe directory.

Techniques

Are strategies that we follow for implementing nettests, hypothesis we are interested in testing and implementation details for each target platform. See the techniques directory.

Data formats

Define how data is presented to end users or analysts. See the data-formats directory.

Backends

Are core OONI infrastructure components that are necessary to carry out experiments. See the backends directory.

Contributing

Please, see CONTRIBUTING.md.

spec (ooni/spec)

Searching Database…

204 ·GitHub
Что это такое?Это OONI Spec — репозиторий, где OONI открыто описывает свою методологию тестирования: эксперименты (nettests), которые она проводит, серверные компоненты, используемые для тестирования, и форматы данных для результатов.
Это программа, которую можно запустить, или письменная документация?Письменная документация: набор документов-спецификаций, которые поддерживаются в рамках процесса, похожего на процесс интернет-стандартов RFC, — это не программа, которую можно установить и запустить.
С чего мне начать чтение?С README, затем с отдельного введения, где описано, как устроена работа OONI с точки зрения OONI Probe; именно этот вход в README предлагают новичкам.
Для кого написаны эти спецификации?Прежде всего для новых разработчиков OONI — им рекомендуют читать их, чтобы понять контекст, а также для всех, кто хочет самостоятельно реализовать тесты OONI.
Что такое nettest?Nettests (их также называют экспериментами) — это сетевые эксперименты, которые дают результаты, понятные и полезные обычным пользователям; именно их OONI Probe фактически выполняет, когда проверяет ваше соединение.
Что находится внутри репозитория?Спецификации сгруппированы в пять разделов: nettests (сами эксперименты), probe (программа тестирования для пользователей), techniques (стратегии реализации, гипотезы и особенности отдельных платформ), data-formats (как результаты показываются пользователям и аналитикам) и backends (основная инфраструктура, которая выполняет эксперименты).
Почему OONI пишет формальные спецификации, а не просто выпускает код?Процесс в стиле RFC нужен, чтобы глубоко понимать, как работает каждый тест, явно фиксировать все допущения и дать любому желающему возможность создать независимую реализацию этой методологии.
Что такое сам OONI Probe?Это программа, которую запускают пользователи, чтобы выполнять nettests; каталог probe здесь описывает её, а отдельную документацию по установке и использованию OONI публикует отдельно.
Creator
ooni
Size
2.6 MB
Stars
204
Updated
CommitSep 29
Age
13y
Commits · 90 Days