Updating stem's usability improvements project idea
Damian Johnson

Damian Johnson commited on 2013-03-08 17:57:52
Zeige 1 geänderte Dateien mit 14 Einfügungen und 20 Löschungen.


Many of the subtasks for stem's usability project have been done. Replacing
those with other tasks I've come up since then. I'm also requiring a code
sample from applicants to better get them engaged during the application
process.


... ...
@@ -660,7 +660,7 @@ meetings around the world.</li>
660 660
 
661 661
     <p>
662 662
     <b>Project Ideas:</b><br />
663
-    <i><a href="#stemUsability">Stem Usability Improvements</a></i>
663
+    <i><a href="#stemUsability">Stem Usability and Porting</a></i>
664 664
     </p>
665 665
 
666 666
     <a id="project-txtorcon"></a>
... ...
@@ -1714,7 +1714,7 @@ meetings around the world.</li>
1714 1714
 
1715 1715
     <a id="stemUsability"></a>
1716 1716
     <li>
1717
-    <b>Stem Usability Improvements</b>
1717
+    <b>Stem Usability and Porting</b>
1718 1718
     <br>
1719 1719
     Effort Level: <i>Medium</i>
1720 1720
     <br>
... ...
@@ -1728,7 +1728,7 @@ meetings around the world.</li>
1728 1728
     href="https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt">control
1729 1729
     protocol</a> to help developers program against the tor process, enabling
1730 1730
     them to build things similar to <a href="#project-vidalia">Vidalia</a> and
1731
-    <a href="#project-arm">arm</a>.
1731
+    <a href="http://www.atagar.com/arm/">arm</a>.
1732 1732
     </p>
1733 1733
 
1734 1734
     <p>
... ...
@@ -1739,29 +1739,23 @@ meetings around the world.</li>
1739 1739
     </p>
1740 1740
 
1741 1741
     <p>
1742
-    Stem is very nearly feature complete but presently has no users. We
1743
-    want to change that prior to making our first release for a couple
1744
-    reasons...
1742
+    Stem has largely met these goals but there's still plenty of low hanging
1743
+    fruit in terms of usability improvements. Also, we have clients still using
1744
+    TorCtl that need to be ported over. This project includes several subtasks,
1745
+    see the tickets for additional context...
1745 1746
     </p>
1746 1747
 
1747
-    <ul>
1748
-      <li>Make sure that we have a reasonably good API, and improve the rough
1749
-      edges that hurt its usability.</li>
1750
-      <li>Provide examples for how stem can be used.</li>
1751
-    </ul>
1748
+    <ol>
1749
+      <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>
1750
+      <li>Navigation of <a href="https://stem.torproject.org">stem's site</a> is clunky, in large part due to the linear page flow supported by sphinx. One possible fix for this would be css-only menus, ideally as a sphinx plugin so we could contribute it back upstream.(<a href="https://trac.torproject.org/8431">ticket</a>)</li>
1751
+      <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.</li>
1752
+      <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/tutorial.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>
1753
+    </ol>
1752 1754
 
1753 1755
     <p>
1754
-    This project involves several tasks...
1756
+    <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/tutorial.html">make a tutorial</a> around!
1755 1757
     </p>
1756 1758
 
1757
-    <ol>
1758
-      <li>Move stem's site to Tor's website (<a href="https://trac.torproject.org/projects/tor/ticket/7324">ticket</a>)</li>
1759
-      <li>Set up Piwik for our site (<a href="https://trac.torproject.org/projects/tor/ticket/7424">ticket</a>)</li>
1760
-      <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>.</li>
1761
-      <li>Finally get your hands dirty using stem. We want to expand stem's <a href="https://stem.torproject.org/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>
1762
-    </ol>
1763
-    </li>
1764
-
1765 1759
     <!--
1766 1760
     <a id="tailsServer"></a>
1767 1761
     <li>
1768 1762