Confused documentation under versionless URL

aaron.lane's Avatar

aaron.lane

20 Nov, 2017 10:55 PM

If I search for my gem kitchen-terraform, I see the result in the screen shot attached. My assumption is that result is indicating that version 2.1.0 (the latest) is the default version that will be displayed at the URL http://rubydoc.info/gems/kitchen-terraform/. Loading that URL displays the README from 2.1.0 as expected, but the objects linked in the sidebar seem to be a mishmash of outdated and deleted objects. For example: Kitchen::Driver::Terraform points to http://www.rubydoc.info/gems/kitchen-terraform/Kitchen/Driver/Terra..., which displays the object from version 1.0.1 rather than 2.1.0; Kitchen::Driver::Terraform::VerifyClientVersion points to http://www.rubydoc.info/gems/kitchen-terraform/Kitchen/Driver/Terra... which is a broken link as the object was removed in version 2.0.0.

So far, this documentation has been automatically generated when my gem was uploaded to rubygems.org. Have I messed up some YARD configuration option or should I just always use the versioned gem URL like http://www.rubydoc.info/gems/kitchen-terraform/2.1.0/?

  1. Support Staff 1 Posted by nap on 26 Nov, 2017 04:05 PM

    nap's Avatar

    Looks like this is all set now. Might've been a temporary caching issue. Let me know if you believe otherwise. Thanks!

  2. nap closed this discussion on 26 Nov, 2017 04:05 PM.

  3. aaron.lane re-opened this discussion on 27 Nov, 2017 06:04 PM

  4. 2 Posted by aaron.lane on 27 Nov, 2017 06:04 PM

    aaron.lane's Avatar

    @nap: thank you for your reply.

    The issue does appear to be resolved now, but the gem was last updated on October 11 and I noticed this issue as early as September 20 so I do not think the issue was temporary in nature. Is there any behaviour on the site that would account for such a delay in refreshing the docs?

  5. Support Staff 3 Posted by lsegal on 27 Nov, 2017 06:47 PM

    lsegal's Avatar

    Caching issues is usually the reason for these types of problems. We tend to cache fairly aggressively and sometimes we do not correctly purge all documents when a new gem is released (possibly because the initial invalidation fails).

    Sorry about the delay in responding to this issue. If you see this thing happen again please open an issue and we will try to resolve it ASAP!

  6. 4 Posted by aaron.lane on 27 Nov, 2017 06:55 PM

    aaron.lane's Avatar

    @lsegal: thanks for the clarification!

  7. aaron.lane closed this discussion on 27 Nov, 2017 06:55 PM.

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

Keyboard shortcuts

Generic

? 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