Introducing Ohloh Journaling

Avatar
written by Jason Allen
may 28 2008
 

We've quietly deployed a new Ohloh feature: journaling. It's a simple tool that lets you keep notes on what you're doing.

What goes into your journal is is up to you. Here at Ohloh, for example, we use it to to let each other know what we're working on. Here's a short video introducing the feature.

Other Formats: avi (5.9MB) mp4 (5.7MB)

Remember, you can link your journal entries with people or projects. For a person, use the "@" symbol, while projects are referred to with the '#' sign. Example: "@jason, you should look into #couchdb".

The flip-side of journaling is 'following' people. You can follow both people and projects. When you follow a person, you will see every journal entry they author. When you follow a project, you will see every journal entry linked (or tagged) with that project - regardless who authors it.

There's more to the feature. For example, you can update your journal AND receive news updates directly from your Jabber/XMPP client. Also, journal and news page contents are readily accessible in alternative formats (xml/json/rss/csv). Check out the Journal FAQ for more info.

How this feature evolves is up to the collective "us". We're slowly getting addicted to this feature here at Ohloh - try it out and let us know how you use it (and what you'd like to see added or changed). Btw, you can now reach me directly by messaging @jason.

Look for a more official/splashier announcement of this feature in the coming days.

Comments (42) Subscribe to Introducing Ohloh Journaling

Avatar

Jumpin-Banana

3 months ago

eh cool stuff ;-)

its like twitter but way more "professional" ;-)


Avatar

dartar

3 months ago

Clever, I'm curious to see how people will start using this.

Possible future directions?

  • update journals by mail
  • support IRC on top of Jabber

Avatar

Jason Allen

3 months ago

@jumpin-banana - A deep bow to twitter. Funny how I never really used twitter, yet I think we're on to something here. Anyway, we differentiate with twitter in 2 ways:

  1. Context: We're not interested in what movie you just saw or what you ate for breakfast - just software-related stuff, please.

  2. Integration: We will integrate this tool into the places where technical people live. IM, IRC, IDE's, consoles, etc...


Avatar

Jason Allen

3 months ago

@dartar - Our next integration point will be IRC. The current design is that you will be able to message the ohloh_bot with the same commands that we support in Jabber/XMPP. Feedback appreciated!


Avatar

Jumpin-Banana

3 months ago

@Jason Allen Well I never and will use twitter. I just know what it is..

yeah and keep it technical otherwise we will have a mess here...


Avatar

dartar

3 months ago

Our next integration point will be IRC

that's sweet!


Avatar

Daniel / Nazca

3 months ago

oh my goodness that looks sexy.

Now what you really need to do is figure out how to integrate with with the RSS feed pulling stuff so blog posts elsewhere can be used as journal fodder :p


Avatar

hangy

3 months ago

Please make any message prefixed with the exclamation mark not published on the website. :) That way, someone typing "!hel" instead of "!help" by mistake would not generate weird journal entries ... :)


Avatar

JavaWoman

3 months ago

So can you "introduce the feature" with words? I really can't use video as a source of information - just tell us about it!


Avatar

JavaWoman

3 months ago

Apart from an introduction - just how do you plan to "keep it technical"? Spammers are constantly on the lookout for new venues...


Avatar

Jason Allen

3 months ago

@hangy: I agree - I'll fix that right now.


Avatar

Jason Allen

3 months ago

@JavaWoman: sorry about the lack of documentation - I am working on the official launch of the feature and it will include more text.

Also, I plan on a 2-phase approach to keep the content technical and relevant. Phase 1 is a manual one: we are still a small community and I will personally warn/remove/ban anyone abusing the system.

Phase 2 will involve trying to automate phase 1. A type of karma-based system w/ community flagging.

Meanwhile, if anyone sees spam-ish content, message me "@jason" and I'll take action immediately.


Avatar

JavaWoman

3 months ago

@Jason, Ok, will wait for more documentation (as in "words"). ;)

You 2-phase approach sounds good - as long as you keep on top of it. Watching Twitter I'm somewhat worried, while GetSatisfaction does have a reporting system (a link on every post).

Finally, how about an API? I *do* use Twitter, and don't see myself "journaling" the same things in two places. Now Twitter has an API and I could easily build a script that picks up my latest tweets and repurposes them (in fact I'm planning to do something like that for a different purpose anyway). I could pick up a "code" and send such filtered tweets back to Ohloh; now I could fake a form post (if you have a form!) but an API would be a cleaner way to do it.


Avatar

Jason Allen

3 months ago

@hangy: sorry - took longer than anticipated (well, lunch also got in the way). Any jabber message starting with a "!" will not create an entry.


Avatar

Regit

3 months ago

@Jason, It seems project link send to an invalid page. If I prefix with #project (in my case #NuFW) generated link is not sending to a valid page.


Avatar

Jason Allen

3 months ago

@Regit: Sorry for the confusion. I need to document this better (as I did above -- still working on it). The shorthand '#' name needs to match the project "URL NAME".

This, somewhat confusingly, can be different than the official title of a project. I guess the analogy is that the title is meant to be the long, official one and the url_name is meant to be the shorthand/codename.

The "NuFW" project does not yet have an url name -- the url for the project still reads http://www.ohloh.net/projects/1073. You can change the "1073" part to be "NuFW" by editing the projects Summary info.

Sorry for the confusion. As I said - I am work on making this more obvious right now.


Avatar

Jason Allen

3 months ago

@JavaWoman: Regarding an API. We will have an API to post & manage your journal entries. The hang-up right now is simply because our current API infrastructure was not setup to really "impersonate" anyone - it's more of an official scraping mechanism.

Now that we have content that we hope/expect people to update regularly, we need to incorporate "authorization". Right now I'm leaning towards moving us towards OAuth for specifically this reason.

Lastly I am very eager to see maximum integration with other tools (IRC, IDE's, etc...). I am a little concerned with bridging from Twitter, however, for the same reasons u mentioned above: how to ensure our content stays technical/relevant?

Twitter is fairly context-free, and while many people tend to post Ohloh-relevant entries, I am wary of random stuff showing up here (e.g: "latte is scalding hot!", "sunny this afternoon", etc..

Thoughts?


Avatar

JavaWoman

3 months ago

@Jason, I'd just do my own "bridging". I'd prefix a tweet with a code (say 'ohl:') and my program would pick up only those updates (minus prefix) to send on to Ohloh. What it boils down to then is that I type it only in one location (Twitter) but if I make the decision it should go to Ohloh as well, I'd add the prefix. So whether I type here, or in Twitter, it's still my decision that it's content for Ohloh (as well).

What I type in Twitter would be all my things, I'll only filter some of that (by prefix) to also go to another destination (another I have in mind would be updating my Travel Blog from my phone via Twitter ;)).

My Twitter update "Sunny this afternoon" might then appear in my Travel blog (if appropriately prefixed), but not in Ohloh.

Clear as mud?


Avatar

Jason Allen

3 months ago

@JavaWoman - makes perfect sense. I went to Twitter and reserved the "ohl" account as a preliminary precaution.

In this case, we could possibly do the bridging for you: just message @ohl <...> on Twitter and we'd handle "bridge it over" (assuming you tell ohloh what your twitter account it). Sounds fun!

I have a lengthy work list ahead of me so this won't happen automatically for a while, but I'll keep noodling on this idea. Thanks for the insight.


Avatar

Jakub Narębski

3 months ago

@Jason: I'm waiting for IRC integration. +1


Avatar

JavaWoman

3 months ago

@Jason that's brilliant - http://twitter.com/ohl now has {its|his|her} first follower: http://twitter.com/marjoleink

Maybe you could set up something like having a field for Twitter (etc..??) account in your profile and then @ohl could start following those (or just use their API); that way you'd have a reasonable way to limit it to Ohloh users. Or ask for some verification code maybe.

So... pretty soon, when waiting for a train I have this brilliant idea for #WikkaWiki, type it into my phone, send it to Twitter - and it will appear here. Who needs a desk? :D

Of course _my_ little program is waiting for an available timeslot, too, so no hurry - a little brainstorming is fine for now.


Avatar

dartar

3 months ago

Jason, I'm eager to see Ohloh roll out all these new features. I second JavaWoman's request of a proper API. The reason is the following. Now that you are building clients to interact in real time with the Ohloh DB, I see a number of potential extensions that would make the Ohloh bots much more powerful, were there an actual API to program against.

You could then query the Ohloh bot from Jabber, IRC or Eclipse not just to retrieve journal information but also fresh project and/or developer information. E.g. where is this user located or under what license is this project distributed or even what's the main URL of this project.

OK this maybe sounds like science fiction, just tossing my 2p in.


Avatar

Jason Allen

3 months ago

@dartar: I'm thinking similar things.

Example: we have this feature kinda lying around called "links" - it's a bookmarking list for projects. I kinda think it'd be interesting to think of making the editing and "lookup" of these links through various tools. Just another example of your scenario examples

It's pretty exciting, imho ;-).


Avatar

Jason Allen

3 months ago

@javawoman: ok - i'm sold on the twitter integration. I'll probably try to converge the "jabber" section of an account into "devices" -- a single place to configure what external devices/tools/services you want to integrate with (jabber/twitter/IRC/etc...).


Avatar

Jason Allen

3 months ago

@dartar: btw - I'm game to add a few commands right now just to test the "reference"-tool hypothesis out. Our current commands all begin with a "!". Let me know of any idea you'd like me to try out (license lookup? similar projects to?) and i'll try to code it up.


Avatar

Jason Allen

3 months ago

@Jakub: Yep - its next on my list after deploying a new ohloh home page (with the journal officially being launched). Let me know if you have any other "command" or "reference lookup" ideas along Dartar's suggestions too...


Avatar

dartar

3 months ago

some random ideas about lookup commands

projects

  • !license [project] (main license)
  • !lang [project] (main lang)
  • !commits [project] (# of commits)
  • !lastcommit [project] (who+when+comment)
  • !loc [project]
  • !size [project] (size of the codebase)
  • !rating [project] (aggregate ohloh rating)
  • !devs [project] (# of committers)
  • !users [project] (# of stacks)
  • !homepage [project]

users

  • !about [username]
  • !contrib [username] (list of projects)
  • !kudorank [username]
  • !commits [username] (# of commits)
  • !where [username] (location)

general

  • !usearch [string] (users)
  • !psearch [string] (project)

Avatar

Jason Allen

3 months ago

@dartar: awesome. I love it. I'll see when/what I can get done. Thanks a ton!


Avatar

JavaWoman

3 months ago

@dartar: wow! (or should that be: !wow ?)


Avatar

Matthias Steffens

3 months ago

Nice feature addition, thanks! I've got two requests/comments:

  1. why is the whole news text printed in bold face? IMHO, the dark/bold text of the journal entries is visually too heavy, makes the text hard to read, and kinda ruins the otherwise nice page layout.
  2. I'd like to include HTTP links similar to this. Even better, besides links, support for some other Markdown markup (e.g. phrase emphasis, lists, images, blockquotes, code spans, preformatted code blocks) in Journal entries would be nice!

Avatar

Jason Allen

3 months ago

@msteffens: Good points:

  1. bold comment text: yeah - i agree it's a little ridiculous. I'll fix this asap.

  2. Better journal markup: I am frankly still struggling with this question. I recognize the powerful nature of Markdown, but empirical evidence (ohloh's forums!) suggests that most people don't "like / understand / want" to use it.

Btw, there was a Coding Horror post on markup choices recently - but it also left me undecided.

An extra motivator for this feature is the opportunity to unify our forums markup and journal markup. I'd love to be able to refer to projects this way (#ohcount) - in our forums.

In short - I'd like to wait a little while to see how people like/want this.

btw - very sweet gravatar ;-).


Avatar

Jason Allen

3 months ago

@msteffens - fyi, you can use '##' in a journal entry to quietly tag it (without actually having it show a link in your message).


Avatar

Jason Allen

3 months ago

@msteffens - just deployed formatting fix.


Avatar

Matthias Steffens

3 months ago

@jason: many thanks for the informative comments, and for the quick formatting fix! IMHO, the visual appearance of the journal entries is much better now, and they now blend nicely with the rest of the site layout. Great!

I didn't know about the '##' trick, that's helpful, thanks! I guess it would be nice to include this info in the Journal FAQ, but I'm sure you'll update the FAQ as soon as you can.

I agree with you that it makes a lot of sense to unify the markup in forums and journals. Offering support for a well-known markup language (such as Markdown, Textile or BBCode) obviously has benefits, but I see that this may cause markup "collisions".

I also understand that many of the markup choices remain unused by the majority of users. However, for those who know about it and want to use it, it's an essential feature.

Personally, I'd be more than happy if you could at least add support for inline links (such as '[link] (http://url.com/)') in journal entries. Super nice would be if you'd further allow to use the same markup as is listed in the Markdown "quick help side bar" (that's next to this forum post's entry form) -- sans the header markup, of course.


Avatar

Jakub Narębski

3 months ago

@Jason: It would be nice if Ohloh API was available on #ohloh IRC channel via ohlohbot, something like fsbot on #emacs channel,. I think that '!command' syntax would work on IRC channel (via IRC bot) too.

As to commands: project summary (perhaps first few lines of description) and project homepage, so one could check what is the project they talk about about.


Avatar

Stuart Yeates

3 months ago

Jason Allen: You mention that Markdown is available (but not being used) in the forums. I completely agree with that that it's not being used, but suspect that it's because people don't know about it.

  • There is no hint / link on the "new post" or "edit post" pages as to how to use it.

  • The text explaining it is below the text entry box (and completely off my screen) when I reply to a post.

  • There is no preview button in the forums (which encourages people to experiment once they have worked out that markup is possible). Yes I know that posts can be edited.

  • The layout of the articles page is better (help beside the text entry box), but until just now I'd not realised that articles and forums had different layout...

This is all with firefox 3.0b5 (hardy)

cheers stuart


Avatar

JavaWoman

3 months ago

If you're going to integrate with Twitter, then keep in mind that # (single hash) is used to informally 'tag' things there for the #hashtags service. I have no idea whether double hashes would work with that.

(I have -- even more informally -- started to use it a bit but due to Twitter's current scaling problems it's temporarily non-functional in that it can't pick up new tweets. Still, you can see what it's supposed to do as a result of my lone Twitter voice about Xaraya here. While it's down (or rather Twitter's IM interface is), I can't test double hashes either...)


Avatar

JavaWoman

3 months ago

@jason: I just sent a tweet to @ohl, with "links" to both #xaraya and #wikka - that should give you something to play with. ;)

(not testing, real info in there)


Avatar

Jason Allen

3 months ago

Just an update - I'm now currently working on IRC integration, next will be Twitter.


Avatar

JavaWoman

about 1 month ago

Twitter was cool.

Twitter is crumbling now - not just downtime (that's for everyone), but inability to see more than one or two pages of your time line for many, or not being able to see your own archive, new anti-spam measures overshooting so many people find they cannot add more people to follow ... and the latest: many people losing massive numbers of followers and followees.

So now what? identi.ca is what. Superficially it looks like a twitter clone, but there's a big difference that should appeal to the Ohloh community: it is:

  1. Open Platform
  2. Open Source
  3. Open Content (CC-BY)

Launched just a few weeks ago, it's taking off fast, thanks to its being open source. And identi.ca's daddy, Evan Prodromou, is as open as Twitter is closed: if there's a problem you'll hear about it from him, on identi.ca itself. New features are being rolled out at a fast pace. And it has an API that's compatible with that of Twitter.

So Jason, I would urge you to consider identi.ca integration rather than Twitter integration. Ohloh is about Open Source, after all, so identi.ca is a perfect fit.

And if you're an OSS developer reading this: you should be on identi.ca! Forget about Twitter already, it's been downhill for weeks there.

I'm mostly here now: marjoleink (and busy programming my own little client. ;)) When you arrive, say hi! and I'll follow you back.


Avatar

JavaWoman

about 1 month ago

P.S. identi.ca runs on OS software called laconica. ;)

Now see if you can find Twitter's software here. 'Nuf said.


Avatar

Rodrigo Amaya C.

24 days ago

Suggestion: there should be a Twitter Ohloh account to follow. :)