Apply conversion script to all *.md files. authored by Alexander Hansen Færøy's avatar Alexander Hansen Færøy
[[TOC]]
[[Image(https://collector.torproject.org/images/collector-logo.png, link=https://collector.torproject.org, valign=middle, height=70)]] [[Image(https://collector.torproject.org/images/collector-wordmark.png, link=https://collector.torproject.org, valign=middle, height=20)]]
= CollecTor Development =
![https://collector.torproject.org/images/collector-logo.png, link=https://collector.torproject.org, valign=middle, height=70](https://collector.torproject.org/images/collector-logo.png, link=https://collector.torproject.org, valign=middle, height=70) ![https://collector.torproject.org/images/collector-wordmark.png, link=https://collector.torproject.org, valign=middle, height=20](https://collector.torproject.org/images/collector-wordmark.png, link=https://collector.torproject.org, valign=middle, height=20)
This is a living and changing document to accompany the current project for improving [https://CollecTor.torproject.org CollecTor].
# CollecTor Development
This is a living and changing document to accompany the current project for improving [CollecTor](https://CollecTor.torproject.org).
== Areas of Work
During the course of this project the following sections will more and more turn into descriptions and documentation.
......@@ -14,25 +14,25 @@ Currently, they are a mixture of very defined improvements as well as sketches a
The analysis will be based on log-files and the downloaded files and address the following questions:
==== How many descriptors are missing?
* Details about missing referenced descriptors can be found here: [wiki:doc/CollecTor/AnalysisDescriptorCompleteness Analysis Part 1]
* Details about missing consensus and votes: [wiki:doc/CollecTor/AnalysisVotesAndConsensusCompleteness Analysis Part 2]
* Analysis of missing referenced descriptors on the current development CollecTor mirror: [wiki:doc/CollecTor/AnalysisDescriptorCompletenessFromScratch Analysis of pure download mirror]
* Details about missing referenced descriptors can be found here: [Analysis Part 1](./doc/CollecTor/AnalysisDescriptorCompleteness)
* Details about missing consensus and votes: [Analysis Part 2](./doc/CollecTor/AnalysisVotesAndConsensusCompleteness)
* Analysis of missing referenced descriptors on the current development CollecTor mirror: [Analysis of pure download mirror](./doc/CollecTor/AnalysisDescriptorCompletenessFromScratch)
==== How could this loss be avoided?
* actively monitor resources like available storage space (discussion in ticket #18865).
* verify and improve runtime statistics in order to have a clearer picture (discussion in ticket #19169).
* Extra-info descriptors dropped b/c of parsing problems are counted as missing. This should be avoided. ticket #19170.
==== Next Steps ====
#### Next Steps
Continue analysis when sync-process is deployed.
=== Provide Guide Documents
These guides should be based on the previous work in [https://onionoo.torproject.org Onionoo] and metrics-lib. In detail
These guides should be based on the previous work in [Onionoo](https://onionoo.torproject.org) and metrics-lib. In detail
* Contributor's Guide: create as detailed in #18733 and place the new guide in a central location, which still needs to be identified; this could be a large document in the central place and a small document in CollecTor referencing the main document. (detailed discussion in #18730)
* Release Process (definded in #18732)
* Installation Guide for Operators (adapt the [https://gitweb.torproject.org/collector.git/tree/INSTALL.md existing document]), ticket #18734
* Installation Guide for Operators (adapt the [existing document](https://gitweb.torproject.org/collector.git/tree/INSTALL.md)), ticket #18734
=== Implement the Release Process
......
......