18:01:22 #startmeeting Documentation IRC meeting 12 November 2020 18:01:22 Meeting started Thu Nov 12 18:01:22 2020 UTC. The chair is caroline. Information about MeetBot at http://wiki.debian.org/MeetBot. 18:01:22 Useful Commands: #action #agreed #help #info #idea #link #topic #startvote. 18:01:22 The meeting name has been set to 'documentation_irc_meeting_12_november_2020' 18:01:31 oh boy, it's going to be a long one, lol! 18:01:32 cait I think I found it 18:01:37 oops 18:01:41 #link agenda Documentation IRC meeting 12 November 2020 18:01:43 #info Martin Renvoize, PTFS Euope 18:01:50 #link agenda https://wiki.koha-community.org/wiki/Documentation_IRC_meeting_12_November_2020 18:02:02 #topic Introductions 18:02:09 please use "#info" in front of your introduction to have it show up in the automatic minutes 18:02:18 #info Caroline Cyr La Rose, inLibro 18:02:24 #info Lucy Vaux-Harvey, PTFS-Europe 18:02:40 #info Martin Renvoize, PTFS Europe 18:03:13 [off] my head's not on straight today, I apologize in advance 18:04:04 #info, Thomas Dukleth, New York City [A little pre-occupied with sometime employer in hospital] 18:04:24 #topic Review of action points 18:04:47 First action point was caroline will write out the current workflow 18:05:03 Which has been done, and is available here caroline will write out the current workflow 18:05:18 omg... -_- 18:05:19 caroline will write out the current workflow 18:05:30 link https://wiki.koha-community.org/wiki/Editing_the_Koha_Manual#How_do_Bugzilla.2C_Taiga_and_Gitlab_work_together.3F 18:05:41 omg... sorry! 18:05:46 caroline++ 18:05:53 #link https://wiki.koha-community.org/wiki/Editing_the_Koha_Manual#How_do_Bugzilla.2C_Taiga_and_Gitlab_work_together.3F 18:06:25 this was in response to a question by henryb about the workflow and how all the tools work together 18:06:45 as we discussed last time, it's not the most optimal workflow, but it's the one we have right now 18:06:54 Looks great, will be really useful 18:07:17 all the other action points were to try to optimize this 18:07:20 davidnind will check how we can use gitlab to simplify the workflow 18:07:33 david says he's still working on this 18:07:48 #action davidnind will check how we can use gitlab to simplify the workflow 18:08:16 then I was supposed to check with ashimema on how to work ourselves in the dev workflow on bugzilla 18:08:39 which I haven't done despite the reminder by ashimema lol! 18:08:47 so you guys don't use the 'Manual' keyword at all? 18:08:56 I've never used it 18:09:06 but maybe we should? 18:09:49 I though that was your policy of having devs write better docs 18:10:51 I'll actionize it again so I don't forget 18:10:55 well.. once upon a time I think it was used to make a bug that needed a manual entry writing still 18:10:58 #action caroline will check with ashimema on how to best insert the docs writing into the dev workflow 18:11:18 whereas the 'Documenatation' component was more about 'bugs with the documentation' 18:12:34 but yeah.. we should work out a workflow for including both parties... making sure there's a smooth transition from 'dev has finished writing the code' to 'someone makes sure theres a corresponding manual update submitted' 18:12:38 what is Manual - ByWater and Manual - PTFS-E on the main page? 18:13:09 those are searches I introduced to try and encourage ptfs-e and bywater to write manual entries for the bugs they wrote.. 18:13:11 Yippee, build fixed! 18:13:11 Congratulations! 18:13:12 Project Koha_Master_D9 build #1494: FIXED in 52 min: https://jenkins.koha-community.org/job/Koha_Master_D9/1494/ 18:13:36 are tey based on the Manual keyword? 18:13:44 it filters on who wrote the bug (*@bywater.com or *@ptfs-europe.com) and having the keyword 'Manual'.. 18:13:59 then the idea as once they'd submitted a manual merge request they could remove the keyword 18:14:05 yup 18:14:50 Yippee, build fixed! 18:14:50 Congratulations! 18:14:51 Project Koha_Master_U18 build #944: FIXED in 49 min: https://jenkins.koha-community.org/job/Koha_Master_U18/944/ 18:15:02 When is the best time to add this keyword? like should we have a list of things to go through? 18:15:07 much like the 'release-notes-needed' Keyword is being used at the minute... if it's an enhancement or new feature at push time, the RM adds 'release-notes-needed' and then when we come to work on the release notes we work through all those with that keyword and as we add the release notes text we remove the keyword 18:15:26 well.. I'm not attached to doing it that way. 18:15:33 it just 'a way' 18:15:58 yeah but it seems a good way 18:16:27 then we could add the manual keyword to the Documentation to-do search 18:16:54 :) 18:17:11 We just need to determine when it's best that the docs manager go through and add the keyword 18:17:23 I guess I could do it from the release notes as I do it now 18:17:30 the challenge at the moment is that there's loads of bugs marked with the keyword and I'm not sure which ones have already been dealt with 18:17:51 well.. the RM could add the keyword upon pushing the feature 18:18:00 kinda depends when we want the docs to be written 18:18:16 but not necessarily every bug needs to go in the manual 18:18:18 I've tried writing them before QA before.. but then QA often results in changes.. 18:18:26 like back-end stuff, we don't add to the manual 18:18:34 agreed 18:18:52 so it needs a little interaction as to when something needs a manual update 18:19:03 perhaps that could be part of QA? 18:19:19 I don't want to add to your load 18:19:24 who makes the call to say "I think this will need an update in the manual" 18:19:53 When I go through the release notes to add them to Taiga, I do a first screening 18:20:47 and then the writers do a more thorough one when they come upon this particular task 18:20:59 I think perhaps we only need devs to do this for the bigger features? 18:21:16 But not sure how to define that? 18:21:37 We can ask for help when it's too big 18:21:54 ashimema wrote a bunch for the cash management part since he worked so much on it 18:22:18 Yes, that sort of development definitely 18:22:42 so when do you tend to go through the release notes caroline? 18:22:55 to build your list.. at or just after release? 18:23:15 I do it periodically with the commits on gitlab 18:23:27 it helps me see only the new stuff that's been pushed 18:24:00 reason I like the idea of adding the keyword at PQA time is that the QA person aught to have a good idea as to whether things have changed enough to warrant a manual entry and it also builds the queue of things to do before the release.. so we might stand a chance of having a manual to release with the release 18:24:05 hope that makes sense 18:24:14 manuals tend to be a few month behind.. at lest 18:24:45 yeah that's why I was using the release notes commits to see the pushes as they were pushed 18:25:12 (Joubu's suggestion, I need to give credit :) ) 18:25:30 coolios 18:25:40 that's a reasonable approach 18:26:07 and means the manual keyword is a bit redundant 18:26:13 So I could do the same and instead of adding a Taiga entry, I would just add the manual keyword 18:26:18 taiga would in effect contain the same list 18:26:35 whatever you're most comfortable with 18:26:51 just so long as we're all on the same page :) 18:26:51 well, I think the purpose was to mlimit the number of tools we use 18:27:40 We can try it like this for the 21.05 release and see if it works better 18:27:47 it's very lightwieght to use bugzilla.. especailly as the release note drafts contain links to bugzilla.. you can quickly click through, add the keyword, then close the tab 18:27:52 that's how I did it as release manager 18:28:31 ok so first we have to clean up the manual keyword 18:28:49 #action caroline will clean up the manual keywords in bugzilla 18:29:13 I can probably get cait/rangi to do that (that way they can do a mass clean and disable email so we don't spam the life out of people) 18:29:25 good idea! 18:29:39 #action ashimema will ask cait or rangi to clean up the manual keyword 18:29:54 oh no, i am missing the meeting, again 18:30:07 were you going to draw a fresh line.. i.e. just remove the keyword as it stands from everything and start fresh for 21.05... I think that's probably the easyest thing to do 18:30:09 haha. 18:30:15 naughty cait ;) 18:30:19 #agreed for the 21.05 release we will try using the "manual" keyword instead of Taiga to build up the task list 18:30:20 are here that many actually? 18:30:26 \i'm just volunteering you for things 18:30:32 I see 18:30:55 128 bugs with manual keyword right now cait 18:31:00 but it's probably not going ot happen before next week 18:31:13 oh i thought it was only me using it :) 18:31:14 no worries, it's for next release 18:31:22 i could also try and fix them all... hm 18:31:56 we're talking about making it a more official workflow cait :) 18:32:04 making us all a bit more joined up 18:32:21 sounds good - i meant writing manual patches for the ones i set myself would also be a way to get rid of them :) 18:32:25 info new workflow will be to go through release notes and add the Manual keyword where a manual update is needed 18:32:37 # info new workflow will be to go through release notes and add the Manual keyword where a manual update is neede 18:32:42 #info new workflow will be to go through release notes and add the Manual keyword where a manual update is neede 18:32:47 * cait sends cookies 18:32:54 thanks! I need some 18:33:10 what I'd really like to see if submitters taking a bit more responsability for documenting their submissions... doesn't mean the dev has to write the docs (often us devs are terrible at writing docs people can understand)... but they can and should pester their companies to help them write docs 18:33:13 :) 18:33:16 cookies ! 18:33:41 Yippee, build fixed! 18:33:41 Congratulations! 18:33:41 Project Koha_Master_D10 build #405: FIXED in 56 min: https://jenkins.koha-community.org/job/Koha_Master_D10/405/ 18:33:43 Can there be more than one assignee per bug? 18:34:10 afraid not.. though we could add a custom field to bugzilla easily enough 18:34:14 I could try to assign bugs to docs writers from compagnies of the dev 18:34:20 for 'docs assignee' perhaps 18:34:28 but I think that would be a bit unfair 18:34:59 like kelly and lucyvh would end up with everything 18:35:00 we could propose it 18:35:28 i still think it might be nice to see if someone has already taken it on 18:36:11 but a comment could work too until it gets a lot 18:36:36 I can very easily add the custom field.. just checking if I can make it like assignee allowing you to pick a bugzilla user 18:36:39 I think we should use the comments until we are happy with the workflow 18:36:44 change one thing at a time 18:36:44 caroline: that doesn't look right 18:37:07 who is supposed to set the new manual keyword after the clean-up? 18:37:18 can i still use it in qa when i notice something will need docs? 18:37:22 I would 18:37:27 but yeah please do 18:37:52 It would be the same basic thing I'm doing right now, go through release notes and add where I fell documentation is needed 18:38:19 ashimema proposed to do it during qa, but I don't want to transfer this load to you necessarily 18:39:15 I want to summarize what we agree on 18:39:24 If someone has an objection, please voice it 18:39:51 #agreed the manual keyword will replace taiga for the 21.05 release as a test for this workflow 18:40:21 #agreed docs manager will go through release notes and add Manual keyword where it is needed 18:40:54 caroline++ #being generally awesome 18:41:21 #action change the Documentation to-do search on bz main page to include Documentation component OR manual keyword 18:41:40 * caroline blushes 18:41:53 there might be bugs (not enh) that warrant changes in the docs - so good to keep an eye out for those maybe 18:41:58 i qa 18:42:05 Yippee, build fixed! 18:42:05 Congratulations! 18:42:06 Project Koha_Master_D10_Deps build #134: FIXED in 42 min: https://jenkins.koha-community.org/job/Koha_Master_D10_Deps/134/ 18:42:36 #info anyone can add Manual keyword if they feel it is needed 18:43:13 Project Koha_Master_D10_Deps build #135: FAILURE in 1 min 7 sec: https://jenkins.koha-community.org/job/Koha_Master_D10_Deps/135/ 18:43:15 #action caroline will document workflow for 21.05 18:43:40 anything to add on the topic of workflow optimization? 18:44:43 ok moving on... 18:44:51 #topic Project updates 18:45:03 anyone has project updates? 18:45:24 thd wiki? 18:45:30 Yes. 18:47:50 I am arranging to have a special period of doing a job from a friends home in Washington, DC caring for his father for a couple of weeks which should give me some better concentrated isolation of sorts for the wiki. 18:47:51 good day! 18:48:27 That is likely to be the first two weeks in January. 18:48:52 cool! 18:49:19 I don't think there are any other updates on projects 18:49:25 I will not have my mother stopping me from doing things for Koha, because I am not doing any real travelling. 18:49:59 #topic What's been done so far 18:50:22 We've had a couple merge requests, so that's good 18:50:30 means the manual is being worked on 18:50:50 I know I did a bit because it releives stress for me to work on this lol! 18:51:14 I've managed just a couple - I'm struggling to update systempreferences.rst at the mo! 18:51:27 how are you struggling? 18:51:28 I think the file might be getting too big? 18:51:33 oh! 18:51:45 maybe we shoudl divide it up? 18:51:50 It freezes in my browser so can't make updates? 18:52:02 My just be me :) 18:52:14 ok I'll try to divide it more 18:52:20 by module 18:52:31 I wanted to make smaller chapters anyway 18:53:14 #action caroline (or anyone) to divide the syspref file as it is getting too big for updates through gitlab GUI 18:53:27 It gives you more work - sorry caroline! 18:53:42 As I say, may just be for me? 18:53:52 no worries, like I said it helps me relieve stress :) 18:54:06 :) 18:54:07 I procrastinate by being production on the manual 18:54:08 some chapters are indeed pretty big 18:54:10 it is our biggest, removing hte Administration bits was a first step, but it might not be enough for editing in the browser 18:54:18 string wise... prefs are massive 18:54:21 you can see it on translate 18:54:25 haha.. I know that feeling caroline... 18:54:35 I have a very large 'procrastination list' 18:54:48 sometimes it's good because it gets other stuff done... 18:54:56 indeed 18:55:42 it's something I feel I'm good at so it helps in moments where work is hard 18:56:03 I just need work to quieten down so I can do more manual stuff 18:57:09 #topic Content development guidelines 18:57:26 I had two things I wanted to discuss here, but it's getting late 18:58:03 After Julius' talk at Koha con on accessibility, I looked up how to add alt text to images in the manual 18:58:11 #linkhttps://wiki.koha-community.org/wiki/ReStructuredText_-_Tips_and_Tricks#Images 18:58:18 #link https://wiki.koha-community.org/wiki/ReStructuredText_-_Tips_and_Tricks#Images 18:58:22 I put it here 18:58:49 so when you add images, please add some descriptive text with it to help people with accessibility issues 18:59:17 cool caroline 18:59:28 I noticed there was a start on that :) 18:59:29 #info when adding images, remember to add alt text for increased accessibility 18:59:31 Will do 18:59:47 I'll leavet he other points for next meeting 18:59:57 #topic Next steps 19:00:19 priority is to Work on new features and enhancements for 20.11 19:00:45 #topic Set time of next meeting 19:00:48 Obviously, with or without alt the text of the manual should make things clear. 19:01:29 4 weeks from now is dec 10 19:01:34 is that good? 19:01:35 Trying again: Obviously, with or without alt text for images, the text of the manual should make things clear. 19:01:45 thd indeed 19:02:13 Dec 10 good for me 19:02:17 but if someone with a screen reader is read "image1455" it's not clear if the image adds to the text or not 19:02:41 I for one would be curious what "image1455" is... 19:03:29 Usually images in the manual just show what that part of Koha looks like, images don't necessarily add to the text, but blind people can't know that 19:03:54 so just wirting "add new item type form" at least tells them they aren't missing out on anything important 19:03:57 (I think( 19:04:29 Project Koha_Master_U18 build #945: SUCCESS in 49 min: https://jenkins.koha-community.org/job/Koha_Master_U18/945/ 19:04:30 10 Dec++ 19:04:37 yup 19:04:51 #info Next meeting: 10 December 2020, 18 UTC 19:04:57 #endmeeting