[tor-bugs] #7324 [Stem]: Move stem site to torproject.org

[Tor Bug Tracker & Wiki]

#7324: Move stem site to torproject.org
-------------------------+--------------------------------------------------
 Reporter:  atagar       |          Owner:  atagar
     Type:  enhancement  |         Status:  new   
 Priority:  normal       |      Milestone:        
Component:  Stem         |        Version:        
 Keywords:               |         Parent:        
   Points:               |   Actualpoints:        
-------------------------+--------------------------------------------------
Description changed by atagar:

Old description:

> Stem's present homepage is on readthedocs...
>
> https://stem.readthedocs.org/en/latest/index.html
>
> ... and, while it's a fantastic service, in the long run it would be nice
> for us to be on the torproject domain. This is for a couple reasons...
>
> 1. Shorter, more memorable url that's clearly related to tor.
> 2. Control over the user request logging (or lack thereof).
>
> Moving over shouldn't be conceptually difficult, but will take a little
> work...
>
> 1. We need to register 'stem.torproject.org' (Andrew would know how).
>
> 2. Make a build script that can publish new content. If you had the
> following environment variables then it might be something like...
>
> * $STEM_PATH is the location of a copy of stem
> * $BUILD_ROOT is where we place stem's website builds
> * $WEB_ROOT is apache's root for our site
> * $BUILD_TIME unix timestamp of the latest build
>
> {{{
> cd $STEM_PATH/docs
> git fetch
> export OLD_BUILD_TIME=$BUILD_TIME
> export BUILD_TIME=`date +%s`
> make html
> mv _build/html $BUILD_ROOT/build_$BUILD_TIME
> ln -s $BUILD_TIME $WEB_ROOT
> rm -rf $BUILD_ROOT/build_$OLD_BUILD_TIME
> }}}
>
> 3. Run this build script as a daily cron *and* provide some method to be
> manually ran (maybe by curling a url).

New description:

 Stem's present homepage is on readthedocs...

 https://stem.readthedocs.org/en/latest/index.html

 ... and, while it's a fantastic service, in the long run it would be nice
 for us to be on the torproject domain. This is for a couple reasons...

 1. Shorter, more memorable url that's clearly related to tor.
 2. Control over the user request logging (or lack thereof).

 Moving over shouldn't be conceptually difficult, but will take a little
 work...

 1. We need to register 'stem.torproject.org' (Andrew would know how).

 2. Make a build script that can publish new content. If you had the
 following environment variables then it might be something like...

 * $STEM_PATH is the location of a copy of stem
 * $BUILD_ROOT is where we place stem's website builds
 * $WEB_ROOT is apache's root for our site
 * $BUILD_TIME unix timestamp of the latest build

 {{{
 cd $STEM_PATH/docs
 git fetch
 export OLD_BUILD_TIME=$BUILD_TIME
 export BUILD_TIME=`date +%s`
 make html
 mv _build/html $BUILD_ROOT/build_$BUILD_TIME
 ln -s $BUILD_ROOT/build_$BUILD_TIME $WEB_ROOT
 rm -rf $BUILD_ROOT/build_$OLD_BUILD_TIME
 }}}

 3. Run this build script as a daily cron *and* provide some method to be
 manually ran (maybe by curling a url).

--

-- 
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/7324#comment:2>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online