Documentation – Jared Smith

The Little Things You Find Along the Way

I’m constantly amazed by the little tips and tricks I stumble upon as I’m working to solve problems. Earlier today, I found this little gem.

Apparently, there is a setting in OpenSSH 5.1 and later for visual remote host fingerprinting. The basic concept is that it’s much easier for the human brain to notice a change in a visual pattern than in a string of hex digits. To turn it on, simply add a line that says
VisualHostKey yes to your ~/.ssh/config file. Then, when you go to SSH into a server, you’ll see a visual representation of the remote host fingerprint, in addition to the regular fingerprint, as shown below:

[jsmith@hockey ~]$ ssh fedorapeople.org
Host key fingerprint is 07:d4:02:db:9f:70:d5:2d:7f:1b:6a:df:83:73:95:1d
+--[ RSA 2048]----+
|      ....  .. . |
|       +. ..  o .|
|      . +..    o |
|         = .   Eo|
|        S +   . B|
|         .   o oo|
|            . o o|
|             o +.|
|              o .|
+-----------------+

See, now isn’t that handy?

Documentation (or the lack thereof)

I’m in Seoul, Korea this week teaching one of the ever-popular Asterisk Bootcamp classes. As luck would have it, my hotel room has the most amazing remote control in the world! Not only does it control the big ol’ LCD TV and the DVD player, but it also controls the air conditioner and all the lights in the room (including both lights in the bathroom!)

In trying to actually use the remote control, however, I was given a stark reminder of how important documentation can be. As you probably already know, I try to take an active role in the documentation teams for both Asterisk and the Fedora Project, but never seem to make the time to write as much as I’d like. As such, I can only hope our documentation efforts are more effective than the yellow labels on my remote control — just documenting the bare minimum and forcing the user to experiment to do anything useful (and very likely getting lost in the process).

(It’s my own personal opinion that this is one of the ways that free/open source software often fails to keep up with it’s commercial rivals; Many open source projects can’t afford to hire technical writers, and if they’re lucky enough to have volunteers do the work, there often isn’t much praise for the hard work and effort that goes into it.)

If this reminder has you feeling the same way I am, why not step up to the plate and help out on the documentation front? After all, the fearless leader and the rest of the docs crew needs your help! As the old adage goes… many hands makes light work! We’d be glad to have you join our ranks.

My first thoughts on Publican

So as part of my work with the Fedora Documentation team, I’ve started playing around with Publican. For those of you who aren’t aware, Publican is a documentation tool chain that started out being used internally at Red Hat (where it was called documentation-devel), and is now being opened up and hosted by Fedora. I won’t bore you with all the details yet, but needless to say it makes it easy to get started with writing documentation in DocBook format and getting that documentation packaged up correctly. Continue reading below if you’d like to know more. (If you could care less about documentation, just be on your toes — the docs team is gonna be a lot more efficient in the near future!)

Continue reading My first thoughts on Publican