17:58:52 RRSAgent has joined #epubcheck 17:58:52 logging to http://www.w3.org/2017/06/08-epubcheck-irc 17:59:15 zakim, this is epubcheck TF 17:59:15 got it, tzviya 17:59:26 chair: Tzviya 17:59:49 dauwhe has joined #epubcheck 18:00:26 present+ Avneesh 18:01:01 agenda: https://lists.w3.org/Archives/Public/public-epub3/2017Jun/0005.html 18:01:04 present+ 18:02:01 scribenick: dauwhe 18:02:05 present+ dauwhe 18:03:09 garth has joined #epubcheck 18:03:25 present +Garth 18:03:25 duga has joined #epubcheck 18:03:30 present +Duga 18:03:48 present+ garth 18:03:52 present+ duga 18:03:58 rdeltour has joined #epubcheck 18:04:02 clapierre has joined #epubcheck 18:04:10 present+ 18:04:15 present_ Charles_LaPierre 18:05:02 present+ Charles_LaPierre 18:05:30 tzviya: lots of regrets 18:05:49 ... mattg wins the service award yesterday, but he can't be here :( 18:05:59 ... welcome to the epubcheck task force 18:06:17 ... introductions 18:06:27 rdeltour: Romain Deltour, DAISY 18:06:28 Wolfgang_ has joined #epubcheck 18:06:37 ... working on epubcheck for two years, primary maintainer 18:07:00 ... I'm here to help, but I can't work a lot of hours on the code 18:07:12 Tobias: I'm Tobias Fischer, software dev from DE 18:07:18 ... creator of Pagina 18:07:36 ... volunteering with epubcheck for last 2 years 18:07:55 tzviya: I chair all the things 18:08:00 Naomi has joined #epubcheck 18:08:06 ... and I do everything 18:08:14 garth: co-chair of DPUB 18:08:27 ... Google uses epubcheck in our ingest pipeline 18:08:37 duga: Brady Duga, google 18:08:54 clapierre: Charles LaPierre, Benetech 18:09:14 ... EPUB CG A11y task force co chair 18:09:35 dauwhe: Dave Cramer, Hachette 18:10:16 garth: Kevin Xu is with Google, working on epubcheck in google ingest pipeline 18:10:45 ???: Thomas Ledoux: working on epubcheck 18:11:12 Marissa: Marisa DeMeglio, dev from DAISY 18:11:28 ... work on validation 18:11:37 s/Marissa/Marisa 18:11:43 Naomi: I work for Random Penguin, doing epub process development 18:12:00 Wolfgang_: Wolfgang Schindler from Stuttgart, working on dictionaries 18:12:06 ... not a java dev :) 18:12:22 tzviya: regrets from Readium folks 18:12:49 ... we have quite a long agenda 18:13:01 ... I don't know about the programming; I'm hear to help lead 18:13:18 Topic: Documents 18:13:31 ... our goal is to make it possible for others to contribute to epubcheck 18:13:38 ... break large tasks into smaller tasks 18:13:48 ... so we can hand off small tasks 18:13:54 ... lots of links in agenda 18:14:00 ... we need volunteers 18:14:24 ... we need a detailed list of changes from 3.0.1 to 3.1 18:14:32 ... this is something a non-dev can do 18:14:43 ... with guidance from a mattg doc 18:14:47 ... and then create github issues 18:15:00 ... this person should start by working with Matt, the world's nicest human 18:15:15 Matt's current 3.1 changelog: https://docs.google.com/document/d/1kgoxSEhF_iTyixj6XaZIc0cgruBNNQknaif4fyXqKto/edit 18:15:18 https://docs.google.com/document/d/1kgoxSEhF_iTyixj6XaZIc0cgruBNNQknaif4fyXqKto/edit 18:15:36 ... do we have volunteers to work on this? 18:15:49 garth: what's the one linked in the agenda? 18:16:08 rdeltour: this is not from the work plan doc 18:16:22 tzviya: this is link one 18:16:27 ... epub 3.1 validation 18:16:35 http://www.idpf.org/epub/31/spec/epub-changes-20170105.html 18:16:51 ... we should just go from here 18:17:02 tzviya: matt took that doc, and wrote up the google doc 18:17:10 rdeltour: the google doc is more detailed 18:17:32 Naomi: should we split it up by chunks? I could do some, like do the package doc validation 18:17:41 tzviya: that's excellent 18:17:57 ... how much time do you need? 18:18:15 Naomi: If it's just creating provisional github issues, I think I could do it by the 26th 18:18:22 tzviya: end of month? Excellent. 18:18:33 ... you, matt, and I will follow up to get this started 18:18:50 tzviya: Matteus may offer to help with other sections 18:18:58 ... the next few issues are all connected 18:19:05 ... if you look at work plan doc, link 2 18:19:23 https://github.com/IDPF/epubcheck/wiki/WorkPlan 18:19:30 ... you'll see there is a maintenance release scheduled for epubcheck, version 4.1.0 18:19:55 ... we wanted to get a feel from the group if you think this is a good idea given there's no 3.1 support 18:20:13 Naomi: there are some retailers who are having ingestion issues with our files that are not wrong 18:20:19 ... I think we should do this release 18:20:28 current 4.1.0 milestone: https://github.com/IDPF/epubcheck/milestone/3 18:20:33 rdeltour: I agree. There are many bug fixes and minor improvements 18:20:40 ... we dn't have to wait for 3.1 18:21:05 tzviya: my concern was about publicity, if we release a new version that doesn't include 3.1 it looks bad and is confusing 18:21:13 rdeltour: the story of my life with epubcheck 18:21:29 ... its a matter of marketing. if we make it clear it's a maintenance release 18:21:37 ... and that we're working on 3.1, then we're OK 18:21:39 q+ 18:21:42 ack ga 18:21:49 +1 to Romain's point 18:21:52 q+ 18:21:58 garth: I think it's good to make new version available 18:22:04 ... having 4.1 would be good for us 18:22:13 ack av 18:22:37 Avneesh: in DAISY we have experience with maintence releases while major features are in progress 18:22:47 ... we try to communicate that clearly 18:23:11 Avneesh: I'm C?? for DAISY 18:23:26 s/C??/COO/ 18:23:42 ... DAISY has been quite involved with epubcheck, and I want to help with a smooth transition 18:23:59 tzviya: so consensus seems to be to go for maintence release 18:24:09 +1 for maintenance release 18:24:18 ... let's talk about resource requirement 18:24:29 ... and how much time is required, and what skills 18:24:34 https://github.com/IDPF/epubcheck/wiki/TestSuiteCleanup 18:24:40 ... there's link 1.5 with romain's doc 18:24:52 ... romain, can you walk us through this? 18:25:02 ... let's break this up into tasks 18:25:14 rdeltour: epubcheck comes with extensive integration tests 18:25:24 ... we have a bunch of epubs we run epubcheck against 18:25:36 ... and we check against expected passes/failures 18:25:41 ... several hundreds of tests 18:25:52 ... test suite has grown organically, and is how hard to maintain 18:26:22 ... after a contribution from ??? devs, dozens of tests were added, and it was more obv. that tests were hard to maintain 18:26:39 ... in parallel with 3.1 impl, we should clean up and reorganize test suite 18:26:47 ... make it more maintainable 18:26:49 s /???/Nook/ 18:26:49 s/???/nook 18:26:56 ... this is painful for devs 18:27:07 ... I spent more time fixing test suite than making code changes 18:27:19 ... in this cleanup doc, I tried to define some steps 18:27:24 ... for us to work on 18:27:48 ... 1. define naming convention, for directories and unit test methods 18:27:52 ... there's no convention now 18:28:06 ... it's messy 18:28:45 ... we have to reorg test directories 18:28:56 ... there are two main branches where data is stored 18:29:12 ... there's a 20 directory for epub2, and a 30 directory... 18:29:26 ... and there's some packaged epubs, and some expanded files, and some single docs 18:29:43 ... and more stuff added by BN folks 18:29:52 ... need to merge input data branches 18:30:07 ... and cleanup things like having both expanded and packages 18:30:13 ... easier for devs to use expanded 18:30:33 ... we have to clean up individual tests 18:30:50 ... some are real-world tests 18:30:51 q? 18:31:01 ... some are not minimal test cases 18:31:28 ... and make a minimal base epub 18:31:40 ... and rework test data to work in minimal base 18:31:55 ... sometimes a single test case raises several issues 18:32:11 ... so we need to split, so each test tests a single feature 18:32:33 ... there's also a companion metadata doc 18:32:49 ... epubcheck reads this data 18:32:59 ... hard to maintain; we should get rid of these 18:33:07 * has everybody problems to hear Romain? 18:33:35 ... that's about it 18:33:53 rdeltour: this is not rocket science, but it's annoying, and needs to be done 18:34:08 ... it will take a long time due to the number of tests, but it can be done progressively 18:34:20 ... after cleanup, we can check for test coverage 18:34:29 ... but the cleanup is needed first 18:34:32 tzviya: thanks 18:34:57 ... the 4.1 release is our first priorty, you said it's all but complete 18:35:07 ... what do you need from this group to get 4.1 out the door? 18:35:17 rdeltour: I don't think we need much from the group from 4.1 18:35:38 Tobias: most of the open issues are things which need to be reviewed, like 15 PRs with code changes 18:35:46 ... so there are only 9 open issues 18:35:54 .. for which romain signed up :) 18:36:08 ... we could reassign, but I'm on holiday for next 2.5 weeks 18:36:18 ... to get 4.1 finished we don't need big help from group 18:36:35 tzviya: if you look in the repo, it's broken into projects 18:36:40 https://github.com/IDPF/epubcheck/projects 18:36:47 ... the 4.1 project, and 3.1 refactoring/cleanup 18:37:03 ... those things could be done simultaneously 18:37:24 ... I want to figure out how to break out these tasks into things we can assign to people who are not romain/tobias 18:37:33 ... so we need skills required and time needed 18:37:41 ... might be too early to figure this out 18:37:46 ... might need training 18:37:58 ... right now I can't ask my colleagues to get involved 18:38:08 ... Romain, as you work can you add to wiki? 18:38:13 rdeltour: during this call? 18:38:28 tzviya: like naming convention 18:39:07 rdeltour: I don't think we need call time for naming; one person should volunteer 18:39:39 ... for instance, in first example, it's a convention that test methods start with 'test' 18:39:46 ... but the rest we can make shorter 18:39:54 ... a volunteer should do a naming pattern 18:39:57 tzviya: I can do that 18:40:13 ... reworking test directory org is more complex 18:40:24 ... as well as understanding how validation works 18:40:32 ... this person would work with Romain/Tobias 18:40:36 rdeltour: clarification: 18:40:45 ... it doesn't require knowledge of current tests 18:40:57 ... but it does require knowledge about the epub specs and history 18:41:08 ... whether we want to organize by version and domain 18:41:37 ... one person can propose something first, and then we can match that against current test suite to make sure it's workable 18:41:49 tzviya: brady and garth, no one knows history better than you 18:42:00 https://github.com/IDPF/epubcheck/wiki/TestSuiteCleanup 18:42:00 https://github.com/IDPF/epubcheck/wiki/TestSuiteCleanup 18:42:03 garth: the doc I thought we were using was the work plan 18:42:08 tzviya: there are multiple docs 18:42:14 garth: I see it 18:42:44 ... rework test organization 18:43:40 tzviya: romain said it requires knowledge of history of epub, and how tests might be organized 18:43:49 ... could you or brady do this? 18:44:20 garth: we'll look at it and make comments, and take an initial stab 18:44:26 tzviya: you can put suggestions in the wiki 18:44:29 +1 18:44:34 tzviya: define a minimal base epub test case 18:44:52 rdeltour: it's not complicated 18:45:39 q= 18:45:46 Q+ 18:46:02 ack cl 18:46:12 dauwhe: I can work on minimal test case 18:46:21 clapierre: how can this work? 18:46:36 rdeltour: it's just a base for all unit tests 18:46:57 ... one valid epub file, which can be copied when creating a new test, and then you tweak something in it to make it invalid. 18:47:01 clapierre: that makes sense 18:47:20 Topic: Cleaning up each test 18:47:34 tzviya: anyone with epub knowledge could be trained? 18:47:39 q+ 18:47:43 ... what do you want to see happen here? 18:47:56 rdeltour: we will need to document what needs to happen 18:48:03 ... take one test case in epubcheck 18:48:07 ... run it 18:48:15 * Where would I find the test cases? 18:48:29 ... 2 cases: one, is a test that's expected to pass 18:48:30 q+ Wolfgang 18:48:50 ... in that case you just need to minimize the test case, prune any useless feature from input 18:49:00 ... the other case is for expected failures 18:49:08 ... we need to look at error messages 18:49:32 ... if the messages are about several independent issues, then we need to split the test case, make one for each error 18:49:39 ... and clean up / minimize the input data 18:49:40 ack n 18:49:50 Naomi: all of this is in java, right? 18:50:11 rdeltour: the most difficult part doesn't have to do with java, but is about changing the epub content 18:50:13 BillMcCoy has joined #epubcheck 18:50:14 ack w 18:50:20 present+ BillM 18:50:31 Wolfgang_: my Q is where I would find the test cases, to get a feeling for them? 18:50:41 testcases: https://github.com/IDPF/epubcheck/tree/master/src/test/resources 18:50:43 ... can you post a link? 18:50:47 q+ 18:50:58 ack cl 18:51:20 clapierre: is there any IDE support for the java files? 18:51:32 rdeltour: it's possible to run all the tests at once with Maven 18:51:45 ... you might be able to use that for single test 18:52:02 Tobias: you can run single tests with JUnit in Eclipse (?) 18:52:12 tzviya: if that's not possible, that's something we should add 18:53:01 rdeltour: even running epubcheck against the input data gets you a long way 18:53:07 tzviya: true 18:53:13 (staled) Eclipse plugin for running epubcheck (and editing): https://github.com/rkwright/epubcrude 18:53:18 ... as far as resources, and checking and modularizing 18:53:25 ... it's a very manual task. Correct? 18:53:28 rdeltour: correct. 18:53:37 tzviya: most people in call should be able to understand 18:53:58 ... could we divvy up the files among the ten of us 18:54:02 rdeltour: that's a good idea 18:54:17 ... the prerequisite is to have a naming convention, directory structure, and base epub 18:54:28 tzviya: I'll try to have that tomorrow 18:54:39 s/that/naming convention/ 18:55:05 tzviya: garth should have directory structure by end of next week 18:55:13 dauwhe: I can have base epub next week 18:55:42 tzviya: I'll assign everyone on the call, and some other folks... I'll create a list of files, run tests, and work on documentation 18:55:54 SGTM! 18:55:56 ... everyone will have 2-3 weeks to do that, with ten files to work on 18:56:13 SGML! 18:56:29 tzviya: in a week and a half, we'll have the prereqs 18:56:41 ... four minutes left, for the rest of the agenda 18:56:55 ... if we're doing a 4.1 release, when might the 3.1 release be done? 18:57:04 rdeltour: depends who's gonna do it 18:57:10 ... we don't have dev resources 18:57:21 tzviya: we need to talk to Laurent 18:57:30 ... and do we need to migrate the repo? 18:57:36 ... how often should we meet? 18:57:43 ... is this a good time to meet? 18:57:46 q+ 18:57:48 ... it's late in Euroland 18:57:53 ack w 18:57:56 Wolfgang_: I would like to have it earlier 18:57:57 apologies for my schedule conflict today (that was a one-off conflict though) 18:58:14 ... one hour earlier? 18:58:16 late is good for me, kids are quieter :) 18:58:22 ... once per month works 18:58:28 Agree 18:58:33 q+ 18:58:34 +1 on 1/month 18:58:39 ack av 18:58:55 Avneesh: time is late for me, but i may not need to be in all calls 18:59:04 ... because Romain is here 18:59:25 tzviya: for next call... I scheduled this one around Romain and Tobias 18:59:34 ... right now we're scheduled for this time next month 18:59:45 ... I'll follow up with Romain and Tobias 18:59:56 ... right now webex is for the same time on 6 July 19:00:02 ... I'll create minutes and send summary 19:00:06 rrsagent, make logs public 19:00:13 rrsagent, make minutes 19:00:13 I have made the request to generate http://www.w3.org/2017/06/08-epubcheck-minutes.html tzviya 19:00:16 tzviya: thanks 19:00:19 .nw rgBJA 19:00:28 clapierre has left #epubcheck 19:00:43 thx dauwhe for minuting! 19:00:58 6 July is okay for me. Thanks everybody. 19:01:21 rrsagent, bye 19:01:21 I see no action items