Reports from the Sprint
This is a modal window.
The media could not be loaded, either because the server or network failed or because the format is not supported.
Formal Metadata
Title |
| |
Title of Series | ||
Number of Parts | 36 | |
Author | ||
License | CC Attribution 3.0 Unported: You are free to use, adapt and copy, distribute and transmit the work or content in adapted or unchanged form for any legal purpose as long as the work is attributed to the author in the manner specified by the author or licensor. | |
Identifiers | 10.5446/51351 (DOI) | |
Publisher | ||
Release Date | ||
Language |
Content Metadata
Subject Area | ||
Genre | ||
Abstract |
|
1
8
9
18
20
31
35
00:00
Computer animationLecture/Conference
Transcript: English(auto-generated)
00:00
And now Alec over to you you have a couple of minutes go All right, so it's gonna be chaotic and part of that's because it's gonna be chaotic anyway But we're gonna make it more chaotic by bringing up each of the Sprint groups to have I was gonna say two to three minutes now. It's gonna be about 45 seconds each so Here's the Sprint what we did is basically we got
00:22
People together who had some interest in working on projects and some skills to contribute We stuck them in a room and it's kind of a microcosm of how we do things around the PKP community We have people with too much work. Not much time a lot of pressure Maybe not the the people they need necessarily but the people they have and we put it to work
00:42
I feel a bit like we've just Given you a sausage meal and now we're gonna take a little tour of the sausage factory Which is not there's no good order to do that in but here we are Anyway, this is how we make the sausages. This is how you write the software The rules for a sprint are there is no homework This that was a rule that I maybe didn't articulate well enough at the start because now we have homework
01:03
But you shouldn't bring any homework home from you when you're finished Everyone's welcome. So we have coders non coders people interested in Everything from design to documentation to actually getting down writing some interesting code and you bring your own projects by OP So you come in at the start? We'll set up the the groups based on who's present what they want to work on and we'll get to it
01:24
So after a day and a half We went through a number of different projects If the sprint participants who have slides on this could make their way forward I will start with mine and we'll see who else Has to say a few words. Yes, don't be shy. Come on up Okay. So one thing we did is we had a request from the forum
01:42
That's our user community for a way to make a metadata field required not just available but required and That request will often make its way into a github issue, which is where the coders will do their work As you can see we've created a github issue and we've linked back to the forum So that somebody who's asked for this can say oh, well, there's there's something here. That's now specifying in more technical detail
02:04
What's involved? We added a new column to one of the setup forms to flag a field as required So your language your rights your source, whatever you have And finally we hooked it into the system so that now when you submit An article or when you edit metadata it checks those requirements
02:23
We then went back to the form and said hey it's here You'll know it says at the very top in very gray letters six months later So we don't always get to it as fast as we would like But that's a really typical example of how a request from the community Turns into a bit of work turns into a feature that's added Makes it into the software and then gets back to the user in the first place
02:40
books print Alright, so we had a very big group with for us and we were really focused Updating a document that's called getting found staying found. This is first released in 2006 it was written by Kevin Stronach and It's a really a guidance document around some of the best practices for open access journals
03:03
So what we wanted to do is look at the document pull out different sections and update them. So Here are just some of the sections that we wanted to do So and we had people converge on these specific sections, so we did things like orchid encryption security
03:22
that PKP index Dealing with library union catalogs them. So there was a lot of content produced and a lot of came out of that, too So where we're going from here is to pull all this information together and revise the new document and to align it with the documentation roadmap that another group is going to tell us about because some of it may or may not fit within this document and
03:44
we had a lot of great participation and Thanks to all the people who? Allowed us to exploit their intellect Hey So I was part of a small group of folks who were focused predominantly on the issue of sort of documentation
04:03
and the architecture of our documentation and sort of optimizing it for usability which actually ended up sort of being a conversation about all the Things that are wrong with their documentation in general Chiefly among them the whole onus was that there was some documentation in the wiki there was some documentation and get book It wasn't really clear. What was where so Jana and Janet?
04:21
I did an amazing job sort of combing through the wiki and seeing where all the contents redundant so we have sort of an actionable item and maybe before we sort of Bury the wiki at least update in the wiki to point out You know which sort of software stack that that information is relevant to and give people kind of a sense of what? Documentation is currently deprecated. So we know which parts of the wiki are useful or not to migrate to another platform
04:44
We've had a lot of conversations internally about using get book We started using it two years ago to sprint actually Marco and I were part of a team that tried to get that going And get book has had a lot of issues. So we were talking about where we want to put that material So today actually Alex Kevin and myself
05:00
Did sort of a quick run through an environmental scan of other places to host documentation? I think the likely location is read the docs. That's my homework. I believe And then we inventoried What was you know sort of things that we immediately wanted to put in and the best part is we got a huge amount of recommendations on How we might want to describe that information so we have a problem where we call everything documentation
05:23
But maybe it's better to call things below three pages a guide something above that a documentation or document So we can have people find what they're looking for a little bit easier Usually as we all know you used to look for something and you'd see something entitled OJS in an hour and it was really OJS In the summation of the rest of your life and so this way
05:41
This way you needed something a little bit more expedient You just needed a guide on how to you know help users do something Maybe these guides would be a better way to go So there's actually a shocking amount of homework But the team did a ton of great work and sort of providing us all the information we needed to do that intelligently
06:03
That was earlier than I expected it to be So Some of you may have noticed that there are some elite Hack sores out there who have taken the opportunity to upload profile pictures of themselves saying I hacked OJS which is roughly the equivalent of
06:21
Me if Alec is collecting Name-tags handing my name tag to him writing some profanity on the back of it and saying I broke your arm But it annoys people anyway so We fell back to one of the requests that some journal managers at Pitt have been asking for for a while unrelated to this was the ability to
06:43
Mediate accounts to approve and a new user on the system before the system the user can use the system So we implemented that in 2x and a untested pull request in 3x and You'll see that in two four nine and three point two
07:07
Hi, my name is Elias So we've been working around the open data systems that might appear or get developed in the next years The main issues we have from our field is that people keep doing experiments and other people keep doing the same
07:20
Experiments because the experimental data is not available from materials and mechanics fields We also have another issue is that experimental data itself is not valued as often as a publication But basically the experimental data's purpose is to write a publication after that the experimental data gets lost No one knows where it is and we keep looking for it never finding it. So we just redo the same experiment
07:42
So there are currently several initiatives that are showing up. We were able to discover them through this workshop It was really interesting to exchange with different people about these different initiatives that are trying to be data repositories at the Canadian federal level or also in some universities for example But the the data set still don't have any kind of value even if we store them
08:03
So we thought it would be interesting to make them citeable so that they can be as valued as a publication So the way to implement this would be to fork OGS OMP to create ODS and open data systems that would help us go to the review and
08:21
Evaluation process of a data set until it's actually citeable and we can get clean metadata for it So in the next slide Is it We're just showing what we kind of built which is the review ideal review process for data and that would be per field So in our field mechanics and materials, it would look like this and we'd have an OGS for our field
08:42
But then it would be necessary to develop other OGS for ODS Sorry open data systems for each field That would ensure that the metadata necessary to share that data and make it usable by others will be available through that review process So, yeah the review process will be done in two parts internal one just to check the data format file formats to be able to build the
09:02
Metadata out of it and make it usable by others while the other side will be the external Review just to check the quality and the content if it's actually understandable after that This set with its metadata could then be shared in one of the repositories I was talking about at the beginning one of the federal initiatives was able to talk faster than you
09:28
Okay, so our group was responsible for coming up with some solutions for internal workflow statistics because I don't know if some of you have noticed but the internal Statistics not the ones that are about downloads or accesses, but those that are about the editorial workflow
09:47
Itself have some maybe strange numbers pulling out sometimes So we figure out Well, the the goals were to identify desirable statistics for to be reported from journals
10:01
improve the journal level statistics providing more options other than we what we already have and identify statistics that are not being produced correctly so the solution we came up was to improve first we would have improved some of the CSV files that are
10:21
Reports you can then import to excel and we also came up with a Dashboard kind of thing that would show some of the most important data statistics Sort of in at-a-glance fashion With maybe some graphics on the fly updated on the fly
10:45
And so for implementation we made a list of required fields for those statistics and Filters as well. So we've added some more filters and date ranges We sorted out by priority of developments. So which ones would like to go first and
11:04
so on we also did a benchmark with OGS to take into account what it already has out of the box so we would just add the ones that there isn't yet and we also were able to identify some of a Long-standing issue that was causing some wrong data being pulled
11:24
From reports on OGS too. So this is mostly documentation level we didn't do any coding yet because the group was primarily non technical people, but It's a good start
11:46
So my group was pretty small just two of us to me Tristan myself I've been working with Demetrius for a better part of a year and this was kind of cool because it was the first time we've Met in person so it was interesting Specific problem we want to solve is converting the export XML that you get out of OGS to
12:01
Into a form that can be imported into OGS 3 and the specific use case we have is that we have over 500 journals in the PKP private locks Network now that have Have OGS to XML and we are anticipating having to take them out and make them publicly readable again into an OGS 3 instance
12:23
Sometime in the near future or maybe 15 years from now. We don't know for sure There could be other use cases for this kind of conversion as well We didn't get as far as we wanted to But we the solution we're working on is we want a script to make it completely automatic We you import some OGS to XML into an OGS to instance
12:42
You then upgrade that instance to OGS 3 and you export the XML as XML as OGS 3 XML It's kind of a roundabout way of doing it But we think it's got some legs and we're going to pursue it after the conference
13:03
Hi So one of the new and exciting feature coming to coming with the next release of OGS is the REST API so basically this feature will Hello scripts or People to interact with OGS system without going through the user interface
13:23
So in order for programs to be able to query OGS they need to identify first So in instead of having our own authentication stuff we decided to comply with An open specification which is JSON web token and this integration was successful
13:44
so that part is ready Then And we know that OGS is made of plugins. So In order for the plugins to take advantage of the REST API We had to discuss about the ability for plugins to be able to extend
14:04
via hooks, so We need I was able to to talk to discuss a reliable architecture to prevent plugin conflicts so development for that has started this morning and finally
14:21
Doolip which is also Was was part of our group was it has worked on a document to outline requirements for OMP API
14:41
So this is I didn't really make a pitch for this but there's something I did started before there was a need for editors to be able to kind of customize or personalize rather their journals and a lot of the default themes are like kind of Not really distinguishable. So I think there was a need for new themes. So right now I'm working on six themes
15:01
And during the sprint I had the chance to speak to people who were actually working on OGS3 So I had some more specific questions Alex showed me around Around the code, but there was no code then it was mostly like making mock-ups and I worked a bit with John as well So yeah, pretty much right now. I so far
15:20
I've made a theme for the health health science based journal The idea is to make themes based on academic areas of research So, yeah, I'm getting feedback I have the I have the Prototype online as well. So anyone can comment on it and check it out That'd be really cool actually and helpful to get points of view from different people
15:41
And the second part actually on which we John and I spent the most time was just kind of reworking the logo it's at the bottom of it and I think that was something that was a source of conflict maybe not conflict with So yeah, so we just did that and yeah, so some eye candy pretty much
16:00
Yeah Thank you, so I can't underscore the size of the brain trust we had in that room and being as we do work remotely We never had the chance to meet each other never let much less the committee members and the community at large So it's a really rare opportunity for us to get some Interesting work done and figure out what everyone's like as a person as well. Not just as a screen name
16:21
Watch the PKP blog The link is here for some detailed reports that will provide some more details on everything that we accomplished and some links to Results and that sort of thing So you'll be able to find out more if you're interested and see what legs each one of these sub projects has And finally, please consider joining us next time We have rules for techies non techies everyone if you you won't necessarily be able to bring a specification and have somebody write it
16:43
But if you're interested in getting your your knuckles dirty, then that's a really great way to do it We try to hold them in spring and fall generally speaking Although this year that I think we're only doing one issue one event So consider watching for the next event to be announced on the blog PKP blog and coming out