Gem documentation appears to be unavailable for some gems (at the least after a gem push, click on documentation, but close the tab in the browser before it is finished)

[ghost]

Hello Loren and everyone else who may be reading this issue report,

I am not sure if this is the proper way to report an issue, because the issue is with rubydoc.info rather than yard per se (and I assume that yard can be used very well, without rubydoc.info too).

However had, I was unable or too dumb to find a respective github link to rubydoc.info so I file here. If this is not the right place, please do feel free to close this issue request at any moment in time.

Situation:

• When I push a new gem onto rubygems.org, then there is usually a slight delay before the documentation is available on rubydoc.info.

When I push a new gem, and then, after say, 20 seconds, click on the link "documentation" on the right hand side, I get some kind of spinning cursor thingy and then usually, after some time, I get the converted markdown information.

This works quite ok but not all the time.

Specifically, yesterday, I was uploading a new version of my gem rbt and the rotating cursor thingy was rotating; but then I closed the tab, went to the main page of rbt again, and again clicked on documentation just to see what will happen.

Now rubyinfo can not find any documentation for that gem:

http://www.rubydoc.info/gems/rbt/0.1.404

The message is:

"Oops, We Couldn't Find That Page

Sorry, but we couldn't find the page /gems/rbt/0.1.404 in the rbt gem. Are you sure that class, method, or file exists?"

The gem is at:

https://rubygems.org/gems/rbt

I am not sure if this is a bug per se but I believe that at the least it is not ideal. Ideally the rendered documentation should be available at all times. I can not recommend any way to really "fix" this because I am not familiar with the code base or the behaviour. But I believe that in cases like the above, I'd rather like to re-render the documentation, than have a missing documentation.

Perhaps rubydoc could try to re-render or re-check again if such a gem exists (it should exist). Alternatively or additionally, perhaps there could be an entry, at the least on rubygems.org for the respective gem owner, to re-trigger the generation of the documentation. That way I could simply click on it again and have it rendered anew - admittedly this latter option may require a bit more code and cross-checking with the rubygems.org team, so for the time being, my proposal is to simply check again after some time whether the documentation was correctly generated or is still missing. It's ok if this happens the next day, for instance; that is better than to be unable to have any documentation for that particular gem.

I can workaround it by uploading a new version, granted, but I wanted to wait a bit and report this first, just so that you and everyone else who is involved in the infrastructure/documentation part, knows about this. :)

Thanks for reading!

Edit: Just found https://github.com/docmeta/rubydoc.info and https://github.com/docmeta/rubydoc.info/issues, sorry - I should have posted there, my bad. :\ I'll leave the issue here but feel free to close it, it was merely meant as information anyway. :)

[noraj]

I released a gem (a pre-release version), it was the first version on rubygems, the documentation was available during the 10 minutes following my publishing. I went to eat. I went back 1 hour later and a colleague told me the doc was unavailable, I checked and the doc was dead exept the README.md.

[horgh]

This happened with a prerelease gem for me as well (this week). I saw the docs on rubydoc.info, added them to my docs, but now they 404.