Ticket UUID: | 034355733a92437ab8a25a936bc8a003127f944a | |||
Title: | Dataviz: Installation process unclear/incorrect | |||
Status: | Closed | Type: | Documentation | |
Severity: | Important | Priority: | Immediate | |
Subsystem: | Resolution: | Fixed | ||
Last Modified: | 2018-10-15 21:10:03 | |||
Version Found In: | ||||
User Comments: | ||||
SeanDeNigris added as text/x-fossil-wiki on 2018-10-09 14:22:33:
I am at the following step in the JOSS review process: "Installation: Does installation proceed as outlined in the documentation?" The review ticket has the repo URL pointing to [1] the dataviz page in this repo [2]. I don't see a documentation link on the review ticket, so I went to that url where there was a documentation link, but it was for Grafoscopio, not Dataviz per se. Suggestion #1: Provide clear documentation for Dataviz if that is what is being technically submitted to JOSS. Also, there was this link/text "The Dataviz source code repository on SmalltalkHub". Considering that the audience seems to be largely non-Smalltalkers… Suggestion #2: IIUC Grafoscopio us hosted on mutabit and Dataviz on StHub. What is the purpose of having the code spread out? Use one repo, or at least Provide an explanation as to why there seem to be multiple code repos and the difference between them. The SmalltalkHub repo [3] gives the following installation snippet: "Gofer new smalltalkhubUser: 'Offray' project: 'Dataviz'; package: 'Dataviz'; load." This seems generally unhelpful because it does not manage dependencies. A better snippet might be: "Metacello new smalltalkhubUser: 'Offray' project: 'Dataviz'; configuration: 'Dataviz'; load." This however, fails on Pharo 6.1 apparently due to missing Roassal. It might be easier to have users install into a Moose image which has this preinstalled and indeed the load succeeds in Moose 6.1 Suggestion #3: Provide a simple, working installation process/script in the main documentation; and update the instructions at StHub as well. To test if it was working, I tried to execute the snippet from "Usage instructions & examples" section of the readme [4]: "GrafoscopioDocumentation openDatavizIntro", but apparently the GrafoscopioDocumentation class did not get loaded by the load script. At this point, I'm not sure how to proceed. Suggestion #4: Sync README with installation instructions. As a personal note, I struggle with mutabit (maybe I'm the only one). I'm not sure what they consider wiki syntax in issues (there are quite a few implementations nowadays), can't seem to properly format code, there is no help link that I can see for this in the issue tracker, and googling brings up unrelated topics. Any reason not to host on GitHub? Especially since the JOSS review is there and it's trivial to reference issues, etc. Maybe I'm missing something? 1. https://github.com/openjournals/joss-reviews/issues/720#issue-319942352 2. http://mutabit.com/repos.fossil/grafoscopio/doc/tip/Packages/Dataviz/intro.md 3. http://smalltalkhub.com/#!/~Offray/Dataviz 4. http://mutabit.com/repos.fossil/grafoscopio/doc/tip/Packages/Dataviz/readme.html offray added as text/x-fossil-markdown on 2018-10-15 21:10:03: Sean, Thanks for your observations. I have tried to solve them, starting with hosting the Dataviz package in its own repository, instead of being just a folder inside Grafoscopio's repository. Please follow the link at [1], to follow the discussion on this issue and the actions performed to address it. [1] https://mutabit.com/repos.fossil/dataviz/info/964c4bd0e0b2a112 |