October 30, 2009

Fall 2009 development update

Well, loyal TKS Dev Team fans–I bet you’re dying to know what we’ve been up to this term, huh?

Wait, I’m an editor?

We started off with a pretty major power shift. Matt, our founding developer, graduated last spring and I, Ellie, have taken over his job as lead developer and online editor. It’s been quite the adjustment, but I’ve settled in. I’m also surprised that I’m able to offer some journalistic/editorial contributions to the rest of the staff during our meetings. Unlike Matt, I have no journalism training or experience. When Matt was in charge, he was basically doing two jobs–leading the team and acting as an editor.

Now I consider myself more like a supporting editor. My primary jobs are leading the dev team and acting as a liaison between the developers and the editors/writers/photographers. I also handle a lot of the little technical details here and there so that the editors and the developers don’t have to worry about them. (Stuff like adding HTML formatting to articles, making sure everything has been uploaded and published, making sure the school actually pays our web hosting bill, and of course, hacking together quick fixes when an editor stumbles across a bug.)

It’s been a busy term for everyone on the team, so development has been a bit slower that we’d like.

Fall term projects

Cleaning up/maintenance (Peter) - Peter has been busy this term, but he’s working on some general cleanup and maintenance on our webfaction server. He’s also been trying to merge our tks_redesign branch into trunk, has been facing undocumented and unexpected trouble, and in his frustration has considered giving up on svn and using git instead.

Learning! (Richard) – Richard is a senior and a new member of our team. He’s been working on learning about Django, Python, and web development. (And of course the requisite struggles with setting up a dev environment.) He’s working on a simple intro project:

Template tags for link formatting (Richard) – After noticing lots of unhyperlinked web addresses in stories that I had to convert to HTML hyperlinks, I decided that we should write some simple template tags to automatically convert web addresses to links. (Lots of webapps, email programs, etc. already do this.) So anything following the format “http://” or “www” will be converted to a hyperlink. Email addresses will be converted to a mailto link (or, ideally, something more spamproof.) Simple, but a good beginner’s project.

Email digest feature (Ellie) – This is something I’ve been wanting to work on for a long time. I’m writing an app that hooks into our main “newsroom” application to provide functionality for email-based TKS subscriptions. It maintains a database of subscribed email addresses (unsubscribing is also an option, of course.) Once a week, when an editor (me) clicks a button, the application generates a digest email of the last seven days of articles and delivers it to the inbox of all of the subscribers. It also archives a copy of the email that was sent… just to be safe. Maybe someday we would want the weekly delivery to be automated, but for now I’d rather that a human being be the one to decide when to email possibly even 1000+ email addresses. Our publishing cycle isn’t regular enough and we would have to be able to turn it off over breaks and such.

Right now the bulk of this work is done. (It has been my major project this term, and a lot more effort than I expected.) I’m debugging and working on making the actual email template itself look nice. The goal is to publicly release this feature at the beginning of winter term (but there will probably be a private release late this term to test it out among the staff and such.) Before we deploy it, I also want to add some middleware or something so that we are counting the number of hits we’re getting to the site from these subscription emails. Why?

People are already complaining about the paper copies of TKS that are distributed to everyone on campus each week. Offering a digital subscription option will only make people more frustrated with the paper paper. Someday, TKS will only be online. When that happens, the editors will magically have 10 extra hours each week that they would have spent laying out the paper that they could spend writing stories and publishing them online as they happen. (They will also lose the “valuable journalism experience” of laying out the paper.) I want to have as much data as I can about how people are using the TKS website so that the TKS staff, the college, our advertisers, and the developers can be more informed as the transition looms far off in the distance.

Plans for next term

Usability testing! (Because we need it, and because Ellie has become quite the usability nerd in the course of her Honors project.) Peter is taking CS 262 and is intrigued by the idea. I’ve been noticing a lot of little problems with both the public interface and the admin interface. I want to address those and conduct some usability testing to find more. Some examples include:

  • Using thumbnails to browse photos in admin interface
  • Using live search to search for authors in admin interface
  • Possibly testing the use of a simple markup language and accompanying editor so that staff can apply text formatting. (I’m a big Markdown fan, and there’s a great JS-based editor for it. Check out WMD.
  • Fixing the most glaring usability problem in our public interface: how an unlogged in user sees the article comment section. (Oh, it’s bad.)

Recruiting fresh blood! We’re planning to bring a younger team member on board. We have a few ideas lined up (we’re waiting for them to finish CS 262…)

I think that’s it… thanks for reading! Suggestions and ideas are already welcome.

Signing off, Editor Ellie (epoley at knox dot edu)

May 21, 2009

The grand relaunch, and a farewell

It’s the grand relaunch! The new site has gone live at theknoxstudent.com. We’ve removed the beta badge, overhauled the design of the site, added new functionality and features and cleaned things up behind the scenes. Here’s a quick run down:

  1. Whole New Look!
  2. New Search page complete with filters and and ordering, for all of those advanced queries. Plus it’s all bundled up in a sexy UI.
  3. Overhauled user interface to make TKS easier to navigate and use. Check out our recent headlines bar on the left side of the front page
  4. Popular stories per section, by author and in your search results. Contextual! Oh wow!
  5. New author pages complete with bios and optional head shots.
  6. New Popularity algorithm: we take time into account and the popularity value decays over time.
  7. Polls! Polls!!
  8. Staff-configurable widgets for the front pagelike live-broadcasting via uStream, featured photos, youtube videos and Polls
  9. Nicer looking thumbnails!

The relaunch has been over 6 months in the making and we’re all excited to finally get this out the door. I’m confident this update will bring theknoxstudent.com to a new level and it represents an enormous amount of work.

As now former Online Editor this is also my parting gift to TKS. It’s been a long road since Tom Fucoloro and I started discussing bringing the paper online in the Spring of 2007. Back then Django was still in its infancy and I was a one-man act. Now we have a code base of thousands of lines, a solid feature-filled website and a programming dream team. My how things have changed.

Ellie and Peter have worked incredibly hard and I have the utmost confidence in them. I leave you in their very capable hands.

< / editor >
— Matt Baker

January 20, 2009

Speedier deployment

One of the hurdles in doing frequent updates to the site has been the time (and pain) involved in deploying said updates. Previously I have done it by hand, and until recently we didn’t even have any concept of a staging server.

I’m happy to say I’ve now automated the process. While this won’t help us create features faster it will help us roll out changes with minimal headache. Hopefully this will lead to incremental updates instead of massive deployments with long lists of bug fixes and features (exciting as that my be).

January 18, 2009

IE compatible!

Ellie and I did our first big coding session since being back. We’re close to wrapping up IE compatibility for the site. The major issues are taken care of and the site looks close to identical across IE 7, Firefox and Safari which is great news! 50% of our hits come from IE users (unfortunately) so it’s exciting to know that they’ll be seeing our site in it’s best form.

The IE compatibility push is also important for ICPA, where the judges could be using any browser (even both if they’re techies) to judge our site. This was the main reason behind Ellie and I doing this push, and now that the major issues are out of the way I can rest easy.

Soon Ellie and I will be looking at a redesign for the site. We’ll try to solicit feedback from the staff, a few faculty members and even an alumni or two if we can. I’m excited to update our look, and more importantly enhance the usability of the site.

Peter is looking into a TKS Facebook app that will carry our headlines. The hope is to also scan articles for the names of the users of our Facebook app. For example, if I install this application and an article contains my name somewhere you would see “Matt Baker appeared in the article ‘Whatever’ on theknoxstudent.com” in the newsfeeds. I think it could be a fun tool to bring in some more readers and make us more visible to the student body.

October 30, 2008

0.5 deployed to production

Revision 92 has been tagged as TKS version 0.5. I just deployed it to the django_a server which is where www.theknoxstudent.com currently points. In the future the next deployment will be to django_b, alternating as we release each new version. This allows us to deploy, give it one last look, and then redirect the “www” URL to the new server. In the end we get 0 downtime during an upgrade, since the final operation is just a simple domain swap. This A Good Thing™.

A run down of the new features will follow.

October 29, 2008

Web Meeting Thursday

Just a reminder, the web meeting is Thursday in Borzello Hall (that’s diagonal from GDH) at 6 p.m. We’ll be done by 7 p.m.

October 28, 2008

0.5 RC1

Release candidate 1 has just been deployed to the staging server. It fixes a series of bugs we identified in beta testing (most of those thanks to Ellie). The following changes have been made:

  • Comment box is cleared after saving.
  • Comments made by TKS staff members are of a different color to help people distinguish.
  • The allowed email domains now include knoxalumni.org
  • The “no comments” message is now removed client-side upon the first post.
  • HTML is stripped client and server side.
  • The “this comment has been flagged” message is now appended to the comment, instead of replacing it.
  • Duplicate authors no longer cause the authors view to fail.
  • The final pieces of the moderation tool have been completed.

Testing should focus on the issues outlined in the last post, and on the issues I’ve listed here.

October 27, 2008

Version 0.5 moved to staging

I just moved our next version of the website, 0.5, to our staging server where it will sit in limbo while we test the crap out of it. Stuff we’re looking at in testing:

  • Registering an account
  • Logging in
  • Commenting
  • Comment moderation (broken already I see, whoops)
  • Byline links
  • Adding articles
  • Editing articles
  • Adding photos
  • Editing photos
  • Adding series’
  • Editing series’
  • Adding authors
  • Editing authors
  • Photo display (i.e. click them)
  • Search
  • And much more
Bugs I’ve already come across:
  • Some modifications to the search syntax never made it in. Once that’s done our search should be much more accurate / targeted.
  • Moderation works for delete, but not for unflag, and there’s some weird redirection going on in the middle. 
Once we’ve tested and fixed everything up we’ll move the new version to the production server and let everyone at it. I’ll do a full write up of the changes then so everyone can see what’s new with this release.

Our staging server is at http://staging.theknoxstudent.com/. Although it has the same content as the real website it’s attached to a different database. Adding, editing or deleting content won’t affect www.theknoxstudent.com.