kassifar
commented
1 year ago Hello @rubyFeedback, concerning the ruby quick references we will be contacting our documentation team to take a look at it. However, concerning the feature support table it already exists in the following pages:
Hey GraalVM folks,
Allow me to start with a pointer towards the homepage here:
https://www.graalvm.org/
The homepage looks neat, tidy, clear, has links to other parts and in general the quality is quite high. So no qualms there.
For various reasons I can not check on GraalVM daily, and I have observed myself that when I have not been paying attention for some weeks, I tend to forget things. Now I also make local notes and refreshing things happens quickly, but it still takes a little while, say, an hour or two or so.
Not long ago you guys (or at the least some) published a quick-ref for the python part. It was published on the GraalVM blog (which I tend to read semi-regularly):
https://medium.com/graalvm/graalpy-quick-reference-0488b661a57c
This is very useful and hopefully this could be created programmatically / automatically for ruby as well, and for the rest of graalvm, e. g. "common native-immage commandline options". I know, I know, we can read manpages and what not, but quickrefs are sexy and pretty to look at, so that is useful in my opinion. Anyway, this is an aside, so now to the main gist of this issue.
Every now and then I check how native-image has progressed. I believe windows support is not as easy as linux support (at the least that was when I checked it last a few months ago or so, so my current knowledge may be a bit outdated); on linux things worked very well. On windows this was more limited and/or tedious. Which now brings me to my issue request here - sorry for the lengthy build-up to it.
I would like to have a nice overview, if possible, on the homepage, perhaps a bit similar to how the quickrefs are done (but this is not a requirement, just a comment how it may be done), something where we, as users and visitors, could quickly read up on features and support of GraalVM, such as by comparing different operating systems via a check-list.
For instance:
"Native Support: Windows Linux OSX" yes / yes / yes
(in a nice table layout).
And then next line, for instance:
"Statically compiled executable:"
"Work: partial support, full support, partial support"
Or whatever the status is.
And more useful information. Something where we can, on a single glance, look at what is all available and what works on each platform.
I don't mean this as advertisement though - I mean similar to quickref a quick insta-see "this all works". It CAN be advertisement, whetting the appetite so to speak, but I don't mean this as a PRIMARY purpose; the primary purpose is to quickly inform people what all works, but more on a "developers as target audience".
When this information is available, perhaps even programmatically created so people don't forget to update it, it could be published on the homepage somewhere. For this I suggest a new entry on the homepage, called statistics/ - there, all useful information about statistics are shown, so I suggest a subpage actually. You can also include results from survey, distribute usage and what not, adoption rates - whatever you may find useful there on statistics.
That is meant as INFORMATION only, for people to quickly view. (And also perhaps add a last-update entry to content displayed there, so people know when it was valid.)
The final home could be here:
https://www.graalvm.org/latest/statistics/
This does not exist right now but could be added.
So, one use case I have is to find out when things improve on windows, in regards to statically compiled programs. While I do check the blog, I may not read all blog entries all of the time, so a quick overview would be helpful.
Anyway. This is just a suggestion. Please feel free to close it at any moment in time - it is not a high priority issue of course. (I tried the other template this time here; not sure where documentation-related issues are best put.)