14:00:10 #startmeeting 2020-08-06 - Documentation Interest Group Meeting 14:00:10 Meeting started Thu Aug 6 14:00:10 2020 US/Eastern. The chair is dluch. Information about MeetBot at http://wiki.debian.org/MeetBot. 14:00:10 Useful Commands: #action #agreed #help #info #idea #link #topic #startvote. 14:00:10 The meeting name has been set to '2020_08_06___documentation_interest_group_meeting' 14:00:15 #topic Agenda 14:00:32 #info The agenda can be found here: https://wiki.evergreen-ils.org/doku.php?id=evergreen-docs:dig_meetings:20200806-agenda 14:00:44 Welcome everyone! Today's meeting will be a little bit of discussion but will mostly be time for collaboration and working on documentation. 14:00:57 #topic Introductions 14:00:57 Please paste "#info is , " to identify who you are and what organization, if any, you represent. 14:00:57 #info dluch is Debbie Luchenbill, MOBIUS 14:01:04 #info Bmagic is Blake GH, MOBIUS 14:01:07 #info rhamby is Rogan Hamby, Equinox 14:01:10 #info abneiman is Andrea Buntz Neiman, Equinox 14:01:24 #info jihpringle is Jennifer Pringle, BC Libraries Cooperative (Sitka) 14:03:15 Thank you all for coming! If you join in later, feel free to introduce yourself when you arrive. 14:03:31 #topic Helpful Information: Documentation contributions and collaboration 14:03:31 #info You can find the Documentation Needs List at https://wiki.evergreen-ils.org/doku.php?id=evergreen-docs:documentation_needs 14:03:31 #info DIG Roles can be found at https://wiki.evergreen-ils.org/doku.php?id=evergreen-docs:digparticipants 14:03:46 We are going to do some quick business items... 14:03:49 #info jweston is Jennifer Weston, Equinox 14:04:17 #topic Business 14:04:17 #info Check-in 14:04:17 First off, how is everyone doing? 14:04:17 How are things where you are? 14:04:24 Kicking it freestyle! Doing great! Healthy, working from home. 14:04:40 very hot and humid but ... it's the south so to be expected 14:04:49 ha, yes 14:05:21 Doing ok in MD, my house was spared from Tropical Storm Isaisis (or however you spell it) for the most part 14:05:32 We have been experiencing October-like weather the last couple of days. It's been awesome--all my windows are open! Back to heat and humidity tomorrow, though 14:05:50 abneiman: Good! 14:06:00 Anyone else affected by Isaias? 14:06:30 safe in this part of NC just loud thunderstorms 14:06:44 jweston: Good! 14:07:52 #info Quick report on Antora progress 14:08:01 Anything to report on Antora? 14:09:27 I have a couple questions about Antora/docs server move 14:09:51 (I know it's not a full biz meeting but I think we should talk about them today, given where we are in the release cycle) 14:09:59 Sure, go ahead 14:10:35 caveat: I know I missed the last two meetings, and I did read the notes, but if I'm covering ground that's already been covered please tell me! 14:10:42 The state of it is the same as last meeting - though something to note: I've merged the upstream changes but haven't heard back from gmcharlt or sandbergja 14:10:47 #info rfrasur is Ruth Frasur, Indiana (popping in and out) 14:10:55 https://git.evergreen-ils.org/?p=working/eg-antora.git;a=shortlog;h=refs/heads/user/blake/antora-ui-upstream-sync 14:11:17 so I talked to gmcharlt earlier today abotu what was needed to push Antora to completion - step one is merging the Antora branch 14:11:27 Bmagic, do you think that's ready for a pullrequest? 14:11:41 April Durrence, NC Cardinal (lurking) 14:11:42 #info gmcharlt = Galen Charlton, EOLI 14:11:50 And DIG, are we collectively OK with giving our blessing to its merge? 14:11:55 the git link I just pasted is ready and needs to go to master asap. Though - it's not the Antora branch for the Evergreen repo 14:12:17 so, two branches 14:12:21 the eg-antora one above 14:12:34 and the bug 1848524 one 14:12:35 Launchpad bug 1848524 in Evergreen "wishlist: Antora-ize docs " [Undecided,New] https://launchpad.net/bugs/1848524 14:12:51 eg-antora repo will get updatse as time goes on. Mostly to incorporate the new UI features from upstream. Which is the case here 14:12:52 We have agreed in previous DIG meetings about wanting to go forward with the merge 14:13:01 is there any bar to a committer merging 1848524? 14:13:25 dluch: excellent! As DIG chair, do you mind tossing a comment on 1848524 to that effect? 14:13:40 Sure! 14:13:50 dluch++ 14:13:51 Right before we merge 1848524 - we will want to rm docs; mv docs-antora docs 14:13:56 gmcharlt ^^ 14:14:14 Bmagic: OK, that answsers another question I had in mind 14:14:55 if the docs-antora branch is otherwise up to date, I can commit to merging that in the next day or two and replacing docs/ 14:15:07 (in the master branch, to start) 14:15:12 Couple of outstanding things are: generation of the PG schemas -> HTML and PDF generation of the docs (and epub if we still want to support that) 14:15:15 relatedly, rather than having to do the commit-docs-to-both-branches thing (is that still a thing? my last notes indicates that's still a thing), I propose that we pick a cutoff (like 3.4 since it's still in support) and antoraize everything back to 3.4, and don't worry about updating anything from 3.3 and prior 14:16:22 Bmagic: can those outstanding things be (relatively easily) added post-antorization? 14:16:56 abneiman: At some point we talked about back porting and we sort of decided that we didn't want to take on the back porting project. Just going forward with Antora after it's merged to master 14:17:16 and yes, right now, without it merged, documentation writers will need to make their changes in master AND in this branch 14:17:17 my not-so-secret agenda here as a docs committer is to be able to put 3.6 docs in the right place :) 14:17:34 (and one place) 14:17:40 one_place++ 14:17:40 abneiman++ 14:18:01 so, if DIG & Bmagic agree that that branch is ready, and gmcharlt is willing to merge, it sounds like we're all in agreement? 14:18:11 gmcharlt might be able to speak to the relative easyness for those last outstanding things 14:18:19 Sounds like it to me! 14:18:42 Do folks feel like DIG should make a formal vote, or are we just in consensus? 14:18:45 I didn't find a tool online for converting a PG database schema to HTML. Though I only spent 10 minutes or so looking 14:19:14 but not really a dependency for Antora 14:19:26 we can direct more eyes on finding something 14:19:27 Bmagic: I guess my thought is that, while the pg schema is helpful, I don't really want it to hold up moving this forward 14:19:36 I totally agree 14:19:47 The PDF generation on the other hand, might* be more important 14:20:09 important enough to be a blocker? what are people's thoughts there? 14:20:12 Antora is suppose to be including this functionality: https://docs.antora.org/antora/2.1/project/roadmap/ 14:20:24 What version are we on now? 14:20:41 https://gitlab.com/antora/antora/-/issues/349 14:20:59 I would say it's not a blocker, especially if it's coming in the near future 14:21:25 we are on 2.3 14:21:37 Bmagic what's involved with upgrading? 14:22:05 Antora 2.3 is the latest, but upgrading to a new version of Antora is a piece of cake. It's included in the generate_docs.pl script 14:22:41 sweet 14:22:50 awesome 14:22:52 so then I agree with dluch that this is not a blocker 14:23:10 gmcharlt - if/when you get time to work on this merge, I can be available for any sort of questions 14:23:18 Does anyone else have comments/concerns? 14:24:05 there's the question of moving to the new server but I can toss that to the listserv in the interest of time 14:24:35 We do have a "new" docs server.... which is not currently being used for production links from evergreen-ils.org. What's the plan on that? 14:24:51 abneiman: jynx! 14:25:13 yeah, talking about that here could soak up a bunch of time - listerv 14:25:22 will do 14:25:26 Sounds great, thanks 14:25:31 Big thanks again to Bmagic and remingtron for all their work getting Antora set up and to devted for finding it and everyone in DIG who tested and made suggestions! 14:25:48 Bmagic++ remingtron++ devted++ 14:26:00 and the link again for anyone: http://eg-docs.georgialibraries.org/prod/ 14:26:10 gmcharlt++ abneiman++ for getting it all wrangled in! 14:26:13 Antora++ 14:26:37 Okay, really quickly... 14:26:41 #info Docs Launchpad Bugs need signoffs: 1642023, 1487123 14:26:58 Bmagic++ remingtron++ 14:27:16 I can look at 1642023 14:27:16 bmagic++ 14:27:32 Terran emailed yesterday that these two launchpad tickets need signoffs to proceed. Those two have pull requests but need signoffs first. Can I have a couple of volunteers to check on them and/or sign off? 14:27:34 #info alynn26 is Lynn Floyd, Evergreen Indiana 14:27:43 abneiman++ Thanks! 14:27:46 dluch++ gmcharlt++ abneiman++ 14:27:51 alynn26: do you have more to do on 1642023 before I review it? 14:29:38 Also, I don't know her nick, but terran++ for finding these! 14:29:44 I'll look at it. 14:29:59 Any volunteers for 1487123? 14:30:46 I'll put it out on the listserv, then 14:30:53 Related to that, as I was looking through all the tickets on Launchpad with the tag "documentation," I noticed a bunch that are super-old and/or no longer relevant. I made going through them a suggestion for a possible thing to work on during working time, unless this seems like a project that DIG should work on together. 14:31:29 Thoughts/Questions? 14:31:49 as to LP# 1642023 There is more work to be done, but those can be added later. 14:31:52 dluch: the PR on 1487123 is a couple years old and there's a pending question from gmcharlt about it - and I'm not sure if it will still play nicely with Antora - so taht might need deeper review than just a test/signoff? 14:32:39 abneiman: Okay, sounds good. That was one I hadn't really have time to look over. 14:32:39 dluch: review of old doc bugs sounds great - I don't think it needs to be a group DIG project; just as individual time allows 14:32:42 yeah, my gut feeling is that will need to be looked at afresh post-Antora 14:32:57 jweston: great, thanks! 14:33:18 gmcharlt: Okay, sounds good. We can table that one for a while 14:33:21 re 1487123, I'll remove the PR and note that it needs discussion. +1 to reviewing old LP bugs. 14:33:38 abneiman: thanks! 14:33:48 #info We will catch up on other action items and business at the next meeting 14:33:48 #info Anything else pressing? 14:34:37 Thanks, everyone! 14:34:37 Today's meeting is intended to be for collaboration/working time, so let's move on to that! 14:34:51 #topic Collaboration time 14:34:51 What is everyone planning to work on today? Please let us know here, and feel free to talk and work with each other. If you'd like extra accountability, I can make an action item to show up in the minutes, but it's not necessary. 14:35:17 I know it's a little overwhelming for some folks what to start with, so I made a list of ideas you could work on (alone or with others) if you don't already have something. 14:35:20 If we all start looking at old LPs for docs, I bet we can knock a lot of them out 14:35:38 -your own priority projects 14:35:38 -finishing 3.5 docs 14:35:38 -experimental catalog docs 14:35:38 -cleaning up old docs tickets on Launchpad 14:35:38 -finding docs tickets on Launchpad to work on 14:35:39 -easy tasks from Documentation Needs List 14:35:42 -auditing and removing finished or irrelevant items from the Documentation Needs List and/or adding 3.5 documentation needs 14:35:44 -still-relevant items from the Documentation Needs List (be sure to assign yourself to it so we don't duplicate work) 14:35:46 -documentation-related short videos for the community YouTube channel 14:35:47 to anticipate some of the server move discussion, rhamby and I are working on copying the 3.2 and earlier stuff from the old website to the new one quite soon 14:35:50 -looking through existing docs for things that need updating - text and/or images 14:35:53 abneiman++ 14:36:13 gmcharlt: Awesome! 14:36:21 gmcharlt++ rhamby++ 14:36:51 previously discussed with alynn26 - working on Library Settings and documenting defaults 14:37:10 I have an older download already but I'm refreshing it. I am running into a few errors but I will check those to see if they are red herrings and make sure internal links are relative so it's ready to move. 14:37:15 jweston++ alynn26++ 14:37:53 Bmagic i made up the m_ tables per the slides and im at the import step but when i try and run "INSERT INTO actor.usr SELECT * FROM m_actor.usr;" i get the following error "ERROR: column "name_kw_tsvector" is of type tsvector but expression is of type text" both columns are tsvector 14:38:24 this.... doesn't seem like a docs issue? LP 1076582 14:38:25 Launchpad bug 1076582 in Evergreen "Documentation explaining openils_dojo.js" [Low,Confirmed] https://launchpad.net/bugs/1076582 14:39:11 I'm going to continue working on the experimental catalogue docs - we've started documenting it in our Sitka docs 14:39:18 http://docs.libraries.coop/sitka/_experimental_catalogue.html (EG 3.5) 14:39:56 hi angelo: We're having a documentation interest group meeting here right now, and will be done in about 20 minutes 14:39:58 jihpringle++ also on my to-do list is start reviewing what you've done and touch base on how I can contribute (will reach out in email) 14:40:24 dluch sorry to interrupt 14:40:29 sounds good jweston 14:40:34 angelo: No worries! 14:40:44 jihpringle++ 14:41:21 abneiman: I agree 14:41:34 dluch: yeah I'm going to pull the docs tag from that 14:41:34 Can we remove the documentation tag? 14:41:38 lol, great! 14:41:40 GMTA :) 14:41:47 :-) 14:43:31 I am working on circ training with brief videos, so can work on suitable versions for EG community, if that would be helpful? 14:43:34 I think bug 1192699 can be set to won't fix since it refers to the old Receipt Template Editor 14:43:35 Launchpad bug 1192699 in Evergreen "Various Patron-centric Macros Don't Work with Checkin Receipt Template" [Undecided,Confirmed] https://launchpad.net/bugs/1192699 14:44:00 adurrence: +1 that sounds great! (cc rhamby ^^ since we talked about this in Outreach yesterday) 14:44:40 adurrence: +1 sounds awesome, we can host them on the evergreen community youtube channel 14:44:42 Okay, once I have them ready, I will be posting on our YouTube channel, but can send files to rhamby? 14:44:51 adurrence sure 14:44:58 How about LP 701208? Doesn't seem relevant anymore 14:45:00 Launchpad bug 701208 in Evergreen "Browse Hold Shelf crashes with "large" number of copies" [Low,Confirmed] https://launchpad.net/bugs/701208 14:45:11 adurrence: I'll send you an easy upload link to send large files to me 14:45:20 perfect! 14:45:20 adurrence++ That would be awesome! 14:46:29 adurrence++ +1 to videos; last month we discussed future project of embedding videos in doc -- longer term goals :-) 14:47:33 Yes, was planning to do that with ours, so win/win! 14:49:07 Also, LP 791225 doesn't seem to be docs related at all? 14:49:08 Launchpad bug 791225 in Evergreen "Apache Log error - missing CSS files" [Low,Confirmed] https://launchpad.net/bugs/791225 14:49:19 (also it's old) 14:51:10 dluch: re 701208, I suspect there still might be a need for OpenSRF documentation in that area, per comment #8 14:51:23 Okay 14:51:50 We can leave that one :-) 14:53:21 the other one...... it looks like that's more of an aspirational use of the docs tag? And I'm not sure if this is still part of the install process.... Bmagic or any other developery person want to weigh in there? 14:54:14 ooh this one might be good to get eyes on for feedback fest: bug 1374483 - looks like remingtron put a branch on it during last year's Hack-a-wat 14:54:15 Launchpad bug 1374483 in Trove Integration "Gate blocker. trove-manage command failing while `kick-start`ing" [Critical,Invalid] https://launchpad.net/bugs/1374483 14:54:22 Same with this one: LP 1035347 I have no idea what the chart is showing or if it's still even accurate 14:54:24 Launchpad bug 1035347 in Evergreen "HTTP request handling sequence diagram" [Undecided,Triaged] https://launchpad.net/bugs/1035347 14:54:39 nope wrong number, I meant bug 1375543 14:54:39 Launchpad bug 1375543 in libreoffice (Ubuntu) "package libreoffice-common 1:4.2.4-0ubuntu2 failed to install/upgrade: unable to stat `./usr/lib/libreoffice/program/wizards/web/ProcessErrors.py' (which I was about to install): Input/output error" [Undecided,Won't fix] https://launchpad.net/bugs/1375543 14:55:43 NO DAMMIT why can't I type ..... bug 1374453 and this time I mean it 14:55:44 Launchpad bug 1374453 in Evergreen "Documentation: Image file cleanup" [Undecided,New] https://launchpad.net/bugs/1374453 14:55:47 I was going to say, where's the docs part, lol 14:55:47 there we go 14:56:52 abneiman: ooo, yes! That does look like a good one for feedback fest 14:57:50 sorry, quassel fell over 14:57:52 remingtron and I did some of this image juggling for the antora branch 14:57:53 This is diffently one some one needs eyes on. 14:58:17 This one doesn't look relevant or docs-related, either: LP 1108852 14:58:22 Launchpad bug 1108852 in Evergreen "datasets needs up-to-date README" [Medium,Confirmed] https://launchpad.net/bugs/1108852 14:58:40 Pretty sure the docs-antora folder only received images that were referenced 14:59:06 dluch: not sure if my last msg made it, but, the diagram in bug 1035347 might be helpful if it's still accurate 14:59:07 Launchpad bug 1035347 in Evergreen "HTTP request handling sequence diagram" [Undecided,Triaged] https://launchpad.net/bugs/1035347 14:59:55 abneiman: Thanks, it didn't. Bmagic, could you take a look at that one and see if it is? 15:00:15 (or any other dev-type) 15:00:30 We are at time. Thanks for all the great work, everyone! Feel free to keep going after the meeting! 15:00:42 The next meeting will be September 3. Same time, same place. Business meeting first then collaboration time (if there's time). 15:00:42 Please continue using the email list and/or Launchpad for questions and other things that come up in between meetings. 15:00:42 Thanks for coming! 15:00:43 dluch++ 15:00:51 dluch++ 15:00:56 #endmeeting