[tor-commits] [stem/master] Pluralizing the tutorials page

atagar at torproject.org atagar at torproject.org
Mon Mar 11 09:01:54 UTC 2013


commit 48938b1d95d25ef255c19cfdd7a8a30714a80b76
Author: Damian Johnson <atagar at torproject.org>
Date:   Mon Mar 11 00:22:43 2013 -0700

    Pluralizing the tutorials page
    
    Renaming the 'tutorial' page to 'tutorials'. I can't remove the old page yet since I just sent it to tor-dev@, but now that its only link is swapped over we should be able to move it in a few weeks.
---
 docs/index.rst     |    2 +-
 docs/tutorials.rst |   74 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 75 insertions(+), 1 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index d95a35f..7d18eeb 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,7 +14,7 @@ Stem is a python controller library for `Tor <https://www.torproject.org/>`_. Li
    File: NuoveXT 2.2/128x128/categories/applications-development.png
 
 .. image:: /_static/buttons/tutorial.png
-   :target: tutorial.html
+   :target: tutorials.html
 
 .. Source: http://www.cipherdyne.com/images/anvil.png
    Author and license are unknown
diff --git a/docs/tutorials.rst b/docs/tutorials.rst
new file mode 100644
index 0000000..28ea3d5
--- /dev/null
+++ b/docs/tutorials.rst
@@ -0,0 +1,74 @@
+Tutorials
+=========
+
+.. Image Sources:
+   
+   * The Little Relay That Could - train.png
+     Source: https://openclipart.org/detail/140185/tren-train-by-antroares
+     Author: Antroares
+     License: Public Domain
+     Alternate: https://openclipart.org/detail/1128/train-roadsign-by-ryanlerch
+   
+   * To Russia With Love - soviet.png
+     Source: https://openclipart.org/detail/146017/flag-of-the-soviet-union-by-marxist-leninist
+     Author: Unknown
+     License: Public Domain (not a subject of copyright according the Russian civil code)
+     Alternate: https://openclipart.org/detail/85555/communist-sabbatarian-ribbon-by-rones-85555
+   
+   * Mirror Mirror On The Wall - mirror.png
+     Source: https://openclipart.org/detail/152155/mirror-frame-by-gsagri04
+     Author: Unknown (gsagri04?)
+     License: Public Domain
+     Alternate: https://openclipart.org/detail/174179/miroir-rectangulaire-by-defaz36-174179
+   
+   * Double Double Toil and Trouble - cauldron.png
+     Source: https://openclipart.org/detail/174099/cauldron-by-jarda-174099
+     Author: Unknown (jarda?)
+     License: Public Domain
+
+Getting started with any new library can be rather daunting, so let's get our
+feet wet by jumping straight in with some tutorials...
+
+.. list-table::
+   :widths: 1 10
+   :header-rows: 0
+
+   * - .. image:: /_static/section/tutorial/train.png
+          :target: tutorial/the_little_relay_that_could.html
+
+     - .. image:: /_static/label/the_little_relay_that_could.png
+          :target: tutorial/the_little_relay_that_could.html
+
+       Basics for talking with Tor. This will step you through configuring Tor
+       and writing your first script to talk with it.
+
+   * - .. image:: /_static/section/tutorial/soviet.png
+          :target: tutorial/to_russia_with_love.html
+
+     - .. image:: /_static/label/to_russia_with_love.png
+          :target: tutorial/to_russia_with_love.html
+
+       Rather than talking to Tor, we'll now talk **through** it. In this
+       tutorial we'll programmatically start Tor then use it to read a site
+       through mother Russia!
+
+   * - .. image:: /_static/section/tutorial/mirror.png
+          :target: tutorial/mirror_mirror_on_the_wall.html
+
+     - .. image:: /_static/label/mirror_mirror_on_the_wall.png
+          :target: tutorial/mirror_mirror_on_the_wall.html
+
+       Getting and acting upon information about relays in the Tor network.
+       Relay information is provided through documents called **descriptors**.
+       This walks you through both where to get them and a small script to tell
+       you the fastest Tor exits.
+
+   * - .. image:: /_static/section/tutorial/cauldron.png
+          :target: tutorial/double_double_toil_and_trouble.html
+
+     - .. image:: /_static/label/double_double_toil_and_trouble.png
+          :target: tutorial/double_double_toil_and_trouble.html
+
+       Sometimes it's easiest to learn a library by seeing how it's used in the
+       wild. This is a directory of scripts and applications that use stem.
+



More information about the tor-commits mailing list