jruby in-project generic documentation #8889
rubyFeedback
started this conversation in
General
Replies: 1 comment
-
|
@rubyFeedback - I had started and written a few posts about JRuby on my blog, and intend to continue to do so. The links are all on this collection: https://notepad.onghu.com/tags/#JRuby I would like to see if I can add more, as and when I explore with JRuby and when I get the time. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
I had a look for available books about jruby, in part because on my todo list I have to read more about jruby/swing. (I used to use ruby-gtk in the past, but gtk4 sucks, and I am having TONS of problems with gobject-introspection lately, to the point of actually having given up on it for now. I may at a later time use it again, but right now I am done with ruby-gtk; ruby-libui is still fine though, but I want something more on windows, so since jruby-swing works, I have now decided to use it more).
Some books are quite old, say, JRuby Cookbook, is about 17 years old.
Then there is Using JRuby, from 2011 thus 14 years, headius appears to have contributed to this one.
What if we all could collectively work on a "book" but have that book hosted on github? The format could be similar to jruby cookbook and using jruby; e. g. focus on short samples and snippets, with up-to-date documentation though. The current wiki appears a bit different and I am not sure how easy it is to contribute there.
Naturally headius can not do everything solo, I get that; there is a chicken-egg problem though in that some of this knowledge requires folks who know more about a given topic as such. Anyway, this is just a loose idea here. I guess we may need perhaps a dozen folks who may help contribute to something like a mini-book. I am thinking here of something that is reasonable for such dozen people, say, within three years, to write like 50 useful DIN A4 pages (this is a european standard fairly large book format; I think it is the same as US Letter, e. g. 215.9 mm x 279.4 mm so about 20cm x 30cm, aka about almost 8 inches x almost 12 inches). Something like snippets based, "do this activity, that explained code sample achieves this" and so forth. Could this then be hosted on the github wiki? Perhaps there are other options, I am not too familiar with them. The fpm project uses a nice format: https://fpm.readthedocs.io/en/latest/
Perhaps something similar in style, though more based on examples (e. g. examples first, so people can copy/paste and adjust things as they go; I found this to be the most effective learning, but there needs to be some explanation too, so people can understand and learn).
Another reason I suggest this is because Google search has gotten really bad; and people write on and off about things, e. g. ruby + jruby was probably more used by more people in, say 2010, and right now ruby struggles a bit as we can all see (TIOBE is just one example). I am thinking ruby projects may benefit more if there is more high-quality documentation available on a in-project basis in general. This could help contain information rather than rely on e. g. books or so that may become outdated.
Beta Was this translation helpful? Give feedback.
All reactions