Programmatic access to edit those new gem hyperlinks

dreamcat4's Avatar


30 Mar, 2010 03:05 PM

It seems as if theres no programmatic mechanism to set the optional hyperlinks that appear on the gem page. The ones which we otherwise can manually be set by clicking the Edit button. You know, the Gem Documentation, Gem Source Code, Bug tracker and so on.

It seems that Homepage comes from the Gem specification attribute "homepage". Now that Gemcutter is the official gem repository, these other metadata might be included as optional attributes of a Gemspec. Of course, that may mean modifying RubyGems. Otherwise the relevant fields could be set / get via http on the Gemcutter API.

It seems a rather conspicuous one. Perhaps the idea has already been suggested elsewhere (eg mailinglist)? What was the decision?

  1. 1 Posted by dreamcat4 on 30 Mar, 2010 03:17 PM

    dreamcat4's Avatar

    Okay, just searched the gemcutter mailinglist but couldnt find anything about this. So it seems valid. Perhaps this discussion is more appropriate for the mailinglist?

    On another point, can we stat how many people are actually using the Wiki Link field? It just seems so similar in purpose to the Documentation hyperlink, and therefore may be unnecessary / deprecapable.

  2. 2 Posted by John Barnette on 30 Mar, 2010 03:25 PM

    John Barnette's Avatar

    We've talked a bit off-list about adding arbitrary simple metadata to the gemspec, which would allow for information like this. Adding stuff to the gemspec isn't a simple change, as it involves significant amounts of compatibility work.

    I've taken a few stabs at this on a branch, but nothing worth sharing yet.

  3. 3 Posted by John Barnette on 17 Nov, 2010 07:25 AM

    John Barnette's Avatar

    Closing this out for the moment, it's stale and we can revisit metadata handling after Gem::Specification#metadata lands. On your point about wiki vs. docs, dreamcat4, it's pretty frequent that one points to RDoc or YARD API docs and one (the wiki) points to more long-form stuff.

  4. John Barnette closed this discussion on 17 Nov, 2010 07:25 AM.

Comments are currently closed for this discussion. You can start a new one.

Keyboard shortcuts


? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac