Browse code

Dropping 'Stem Usability and Porting'

We've already migrated Weather or Stem (... or at least have a patch for doing
so). I'm not overly enthusiastic about taking on a student for TorBEL unless
Sebastian wants to mentor. If he expresses an interest in mentoring then we'll
add it back.

Damian Johnson authored on03/02/2014 16:21:51
Showing1 changed files
... ...
@@ -630,7 +630,6 @@ meetings around the world.</li>
630 630
     <p>
631 631
     <b>Project Ideas:</b><br />
632 632
     <i><a href="#txtorcon-stemIntegration">Txtorcon/Stem Integration</a></i><br />
633
-    <i><a href="#stemUsability">Stem Usability and Porting</a></i><br />
634 633
     <i><a href="#stemTestingForTor">Stem Tests for Tor</a></i>
635 634
     </p>
636 635
 
... ...
@@ -844,11 +843,6 @@ meetings around the world.</li>
844 843
     been inactive.
845 844
     </p>
846 845
 
847
-    <p>
848
-    <b>Project Ideas:</b><br />
849
-    <i><a href="#stemUsability">Stem Usability and Porting (this includes an idea for finishing off TorBEL)</a></i>
850
-    </p>
851
-
852 846
     <a id="project-tor2web"></a>
853 847
     <h3><a
854 848
     href="http://wiki.tor2web.org/index.php/Main_Page">Tor2web</a> (<a
... ...
@@ -1014,49 +1008,6 @@ meetings around the world.</li>
1014 1008
     </p>
1015 1009
     </li>
1016 1010
 
1017
-    <a id="stemUsability"></a>
1018
-    <li>
1019
-    <b>Stem Usability and Porting</b>
1020
-    <br>
1021
-    Effort Level: <i>Medium</i>
1022
-    <br>
1023
-    Skill Level: <i>Medium</i>
1024
-    <br>
1025
-    Likely Mentors: <i>Damian (atagar), Sebastian</i>
1026
-    <p>
1027
-    <a href="https://stem.torproject.org/">Stem</a> is a
1028
-    python controller library for tor. Like it's predecessor, <a
1029
-    href="https://gitweb.torproject.org/pytorctl.git">TorCtl</a>, it uses tor's <a
1030
-    href="https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt">control
1031
-    protocol</a> to help developers program against the tor process, enabling
1032
-    them to build things similar to <a href="#project-vidalia">Vidalia</a> and
1033
-    <a href="https://www.atagar.com/arm/">arm</a>.
1034
-    </p>
1035
-
1036
-    <p>
1037
-    While TorCtl provided a fine first draft for this sort of functionality,
1038
-    it has not proved to be extensible nor maintainable. Stem is a rewrite of
1039
-    TorCtl with a heavy focus on testing, documentation, and providing a
1040
-    developer friendly API.
1041
-    </p>
1042
-
1043
-    <p>
1044
-    Stem has largely met these goals but there's still plenty of low hanging
1045
-    fruit in terms of usability improvements. Also, we have clients still using
1046
-    TorCtl that need to be ported over. This project would include several
1047
-    subtasks. Some ideas for instance are...
1048
-    </p>
1049
-
1050
-    <ol>
1051
-      <li>Come up with a better, more developer friendly "Module Overview" for our documentation (<a href="https://stem.torproject.org/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>. (<a href="https://trac.torproject.org/7632">ticket</a>)</li>
1052
-      <li>After getting some exposure to stem it would be time to give using it a try. Tor has a couple clients (<a href="https://trac.torproject.org/8263">TorBEL</a> and <a href="https://trac.torproject.org/8264">Tor Weather</a>) that are ready to be moved to stem. Hopefully porting these will also provide us with some lessons on how we can further improve stem's API. <b>Note that this would also involve polishing off <a href="#project-torbel">TorBEL</a>, including the <a href="https://trac.torproject.org/projects/tor/query?status=accepted&status=assigned&status=needs_information&status=needs_review&status=needs_revision&status=new&status=reopened&group=component&component=TorDNSEL%2FTorBEL&order=priority">issues that prevent us from deploying it</a></b>. This later portion would be primarily mentored by Sebastian.</li>
1053
-      <li><b>... other ideas?</b> The above are just some ideas I've come up with to improve usability and likely not enough to fill the summer. Feel free to suggest some of your own! For instance, one option would be to expand <a href="https://stem.torproject.org/tutorials.html">stem's tutorials</a> with more examples, maybe <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev/">contacting tor-dev@</a> to brainstorm ideas. This last bit is pretty open so I look forward to seeing what you come up with!</li>
1054
-    </ol>
1055
-
1056
-    <p>
1057
-    <b>As part of your application for this project please write a script that does something interesting with stem.</b> Bonus points if this is something that we can <a href="https://stem.torproject.org/tutorials.html">make a tutorial</a> around!
1058
-    </p>
1059
-
1060 1011
     <a id="stemTestingForTor"></a>
1061 1012
     <li>
1062 1013
     <b>Stem Tests for Tor</b>