Skip to content
Snippets Groups Projects
New look: Off

Move stem site to torproject.org

    • Closed Issue created by Damian Johnson @atagar

    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
    1. Run this build script as a daily cron and provide some method to be manually ran (maybe by curling a url).
    To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information

    Child items 0

    • No child items are currently assigned. Use child items to break down this issue into smaller parts.

    Activity

    • Damian Johnson added component::archived/stem owner::neena priority::medium resolution::implemented status::closed type::enhancement website labels

      added component::archived/stem owner::neena priority::medium resolution::implemented status::closed type::enhancement website labels

    • A
      Damian Johnson @atagar ·
      Author

      Trac:
      Description: Stem's present homepage [1] 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
      1. Run this build script as a daily cron and provide some method to be manually ran (maybe by curling a url).

      to

      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
      1. Run this build script as a daily cron and provide some method to be manually ran (maybe by curling a url).
    • A
      Damian Johnson @atagar ·
      Author

      Trac:
      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
      1. Run this build script as a daily cron and provide some method to be manually ran (maybe by curling a url).

      to

      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
      1. Run this build script as a daily cron and provide some method to be manually ran (maybe by curling a url).
    • Roger Dingledine
      Roger Dingledine @arma ·

      Sounds great to me.

      (I was going to ask whether it could just be a few wml files on the main website, but it looks like you want to publish automatically-created api documentation files, and not just a few.)

    • A
      Damian Johnson @atagar ·
      Author

      I was going to ask whether it could just be a few wml files on the main website, but it looks like you want to publish automatically-created api documentation files, and not just a few.

      Stem's website is reStructuredText documents that live with the repository...

      https://gitweb.torproject.org/stem.git/tree/HEAD:/docs

      Making the site this way has a few advantages...

      • consistent look between stem's site and documentation
      • allows for interlinking with the API, which is dynamically generated from the pydocs
      • making the website (or pdf, latex, etc) is trivially easy - just run 'make html'
      • no perl! :P
    • N
      neena @neena ·

      Replying to atagar:

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

      If possible, using a git server-side post-receive hook might be a good idea here.

    • A
      Damian Johnson @atagar ·
      Author

      If possible, using a git server-side post-receive hook might be a good idea here.

      Agreed that it would be nicer, but Sebastian wants to avoid that...

      https://trac.torproject.org/projects/tor/ticket/7247

    • A
      Damian Johnson @atagar ·
      Author

      Ravi says that he could take this on so assigning to him.

      Trac:
      Status: new to assigned
      Owner: atagar to neena

    • A
      Damian Johnson @atagar ·
      Author

      Trac:
      Keywords: N/A deleted, website added

    • A
      Damian Johnson @atagar ·
      Author

      Oops, I should have mentioned it here - filed a ticket for the first step...

      https://trac.torproject.org/7437

    • A
      Damian Johnson @atagar ·
      Author

      I've moved stem's site to 'https://stem.torproject.org/' with a cron job that publishes changes every five minutes...

      https://gitweb.torproject.org/stem.git/blob/HEAD:/docs/republish.py

      I've also deleted the project on read-the-docs, however the latest build is still hanging around. Sent them a ticket requesting for it to be deleted...

      https://github.com/rtfd/readthedocs.org/issues/314

      Resolving.

      Trac:
      Resolution: N/A to implemented
      Status: assigned to closed

    • Trac closed

      closed

    • Damian Johnson mentioned in issue #7437 (moved)

      mentioned in issue #7437 (moved)

    Please register or sign in to reply