Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign upHighlight AUT/AUK Version Number in Interface? #282
Comments
ianmilligan1
added
enhancement
question
labels
Apr 10, 2019
This comment has been minimized.
This comment has been minimized.
|
Different versions of GraphPass could impact network results as well. Overall, I think reproducibility should happen at the researcher level, but it doesn't hurt to give people clues about how the derivatives are produced. |
This comment has been minimized.
This comment has been minimized.
I don't think this is really doing anything other than that, but you do have to give some information to them. Good point on GraphPass! |
This comment has been minimized.
This comment has been minimized.
AUK production only runs on a relesaed version. My thoughts would be to just put it in the documentation. We haven't tracked the version of whatever is running in any database field as we've processed job. So it'll be really hard to back track, and I don't think it is worth the time to wire it up. There have been no breaking or major changes on any of the derivatives generated with the versions of |
This comment has been minimized.
This comment has been minimized.
|
OK perfect, why don't I take this on and basically try to articulate that in the docs? Basically that AUK will always be running on the most recent release of the AUT toolkit, and link to the releases page as well? |
ianmilligan1
self-assigned this
Apr 10, 2019
This comment has been minimized.
This comment has been minimized.
|
Perfect! |
ianmilligan1
added a commit
that referenced
this issue
Apr 10, 2019
ianmilligan1 commentedApr 10, 2019
Is your feature request related to a problem? Please describe.
At CNI, a scholar mentioned that they were wondering about the reproducibility of results generated with the Archives Unleashed Cloud (I don't always think about reproducibility as it's not quite the craze in my corner of the humanities as it is in a lot of the social sciences). While obviously researchers need to hold on to their own derivatives, it might be useful for there to be some indication around what version of the Toolkit the Cloud is running at a given time.
This is both a feature request but also a question at this point, whether it's worth implementing as well as how to do it.
Describe the solution you'd like
There are two ideas that come to mind.
The first is just a note noting what version the data was generated with, perhaps at the bottom of the collection page. Perhaps it would link to the AUT GitHub page, and if a researcher really cares, they'll note this information for citation and reproducibility purposes. Maybe we can read in version information from the config file?
Example 1
The one catch is that we're often running on in between releases, in which case maybe we could just say 0.17.1 and again, they'd need to click through to see what version of AUT we're running on via GitHub.
The second is bundling that data with the downloads, which I'm hesitant to do.
Describe alternatives you've considered
An alternative is to (a) just include this on the docs/etc.; or (b) not do this.