Replace stem's PathSupport idea with usability improvements
Damian Johnson commited on 2012-11-10 21:36:53
Zeige 1 geänderte Dateien mit 55 Einfügungen und 1 Löschungen.
As Ravi discovered during the last GSoC application phase our PathSupport idea is too poorly defined to make a good GSoC (or GSoC-like) project. Replacing it with far better defined tasks for improving stem's usability.
- getinvolved/en/volunteer.wml 9cd740622..82d15855c
| ... | ... |
@@ -557,7 +557,7 @@ meetings around the world.</li> |
| 557 | 557 |
|
| 558 | 558 |
<p> |
| 559 | 559 |
<b>Project Ideas:</b><br /> |
| 560 |
- <i><a href="#stemPathsupport">Stem PathSupport Capabilities</a></i> |
|
| 560 |
+ <i><a href="#stemUsability">Stem Usability Improvements</a></i> |
|
| 561 | 561 |
</p> |
| 562 | 562 |
|
| 563 | 563 |
<a id="project-metrics"></a> |
| ... | ... |
@@ -847,6 +847,59 @@ meetings around the world.</li> |
| 847 | 847 |
href="https://gitweb.torproject.org/torspec.git/blob/HEAD:/proposals/190-shared-secret-bridge-authorization.txt">190</a>.</p> |
| 848 | 848 |
</li> |
| 849 | 849 |
|
| 850 |
+ <a id="stemUsability"></a> |
|
| 851 |
+ <li> |
|
| 852 |
+ <b>Stem Usability Improvements</b> |
|
| 853 |
+ <br> |
|
| 854 |
+ Priority: <i>Medium</i> |
|
| 855 |
+ <br> |
|
| 856 |
+ Effort Level: <i>Medium</i> |
|
| 857 |
+ <br> |
|
| 858 |
+ Skill Level: <i>Medium</i> |
|
| 859 |
+ <br> |
|
| 860 |
+ Likely Mentors: <i>Damian (atagar)</i> |
|
| 861 |
+ <p> |
|
| 862 |
+ <a href="https://stem.readthedocs.org/en/latest/index.html">Stem</a> is a |
|
| 863 |
+ python controller library for tor. Like it's predecessor, <a |
|
| 864 |
+ href="#project-torctl">TorCtl</a>, it uses tor's <a |
|
| 865 |
+ href="https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt">control |
|
| 866 |
+ protocol</a> to help developers program against the tor process, enabling |
|
| 867 |
+ them to build things similar to <a href="#project-vidalia">Vidalia</a> and |
|
| 868 |
+ <a href="#project-arm">arm</a>. |
|
| 869 |
+ </p> |
|
| 870 |
+ |
|
| 871 |
+ <p> |
|
| 872 |
+ While TorCtl provided a fine first draft for this sort of functionality, |
|
| 873 |
+ it has not proved to be extensible nor maintainable. Stem is a rewrite of |
|
| 874 |
+ TorCtl with a heavy focus on testing, documentation, and providing a |
|
| 875 |
+ developer friendly API. |
|
| 876 |
+ </p> |
|
| 877 |
+ |
|
| 878 |
+ <p> |
|
| 879 |
+ Stem is very nearly feature complete but presently has no users. We |
|
| 880 |
+ want to change that prior to making our first release for a couple |
|
| 881 |
+ reasons... |
|
| 882 |
+ </p> |
|
| 883 |
+ |
|
| 884 |
+ <ul> |
|
| 885 |
+ <li>Make sure that we have a reasonably good API, and improve the rough |
|
| 886 |
+ edges that hurt its usability.</li> |
|
| 887 |
+ <li>Provide examples for how stem can be used.</li> |
|
| 888 |
+ </ul> |
|
| 889 |
+ |
|
| 890 |
+ <p> |
|
| 891 |
+ This project involves several tasks... |
|
| 892 |
+ </p> |
|
| 893 |
+ |
|
| 894 |
+ <ol> |
|
| 895 |
+ <li>Move stem's site to Tor's website (<a href="https://trac.torproject.org/projects/tor/ticket/7324">ticket</a>)</li> |
|
| 896 |
+ <li>Set up Piwik for our site (<a href="https://trac.torproject.org/projects/tor/ticket/7424">ticket</a>)</li> |
|
| 897 |
+ <li>Come up with a better, more developer friendly "Module Overview" for our documentation (<a href="https://stem.readthedocs.org/en/latest/api/control.html">example page</a>). For instance, it would be nice to provide interlinking between the overview and the classes/methods that it lists. This will probably involve asking for help from the <a href="http://sphinx-doc.org/">Sphinx user list</a>.</li> |
|
| 898 |
+ <li>Finally get your hands dirty using stem. We want to expand stem's <a href="https://stem.readthedocs.org/en/latest/tutorial.html">tutorial page</a> with more examples. To do this you'll want to both brainstorm some of your own and contact the <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev/">tor-dev@ email list</a> to solicit ideas. This last step is pretty open ended, so go nuts with whatever you think will improve stem's usability!</li> |
|
| 899 |
+ </ol> |
|
| 900 |
+ </li> |
|
| 901 |
+ |
|
| 902 |
+ <!-- |
|
| 850 | 903 |
<a id="stemPathsupport"></a> |
| 851 | 904 |
<li> |
| 852 | 905 |
<b>Stem PathSupport Capabilities</b> |
| ... | ... |
@@ -908,6 +961,7 @@ meetings around the world.</li> |
| 908 | 961 |
Upon reflection this is not an especially good project for this year's GSoC. You are still perfectly wecome to apply for this project, but <a href="https://trac.torproject.org/projects/tor/wiki/doc/stem">other stem related tasks</a> such as implementing a general controller, descriptor fetching, and client migrations would be better. For the discussion that lead to this see <a href="http://archives.seul.org/or/dev/Apr-2012/msg00006.html">this thread</a>. |
| 909 | 962 |
</b></p> |
| 910 | 963 |
</li> |
| 964 |
+ --> |
|
| 911 | 965 |
|
| 912 | 966 |
<!-- |
| 913 | 967 |
<a id="orbot-userInterface"></a> |
| 914 | 968 |