14:00:24 #startmeeting 2014-10-02 - DIG Monthly Meeting Evergreen Documentation Interest Group (DIG) Monthly Meeting. 14:00:24 Meeting started Thu Oct 2 14:00:24 2014 US/Eastern. The chair is yboston. Information about MeetBot at http://wiki.debian.org/MeetBot. 14:00:24 Useful Commands: #action #agreed #help #info #idea #link #topic. 14:00:24 The meeting name has been set to '2014_10_02___dig_monthly_meeting_evergreen_documentation_interest_group__dig__monthly_meeting_' 14:00:38 The agenda can be found here http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:dig_meeting_20141002-agenda 14:00:49 #topic Introductions 14:00:59 Please feel free to start introducing yourselves... 14:01:07 #info remingtron is Remington Steed, Hekman Library (Calvin College) 14:01:09 #info yboston is Yamil Suarez @ Berklee College of Music - DIG meeting facilitator 14:01:26 #info Christineb is Christine Burns @ BC Libraries Cooperative 14:01:34 #info kbutler is Kate Butler, Rodgers Library (Hudson NH) 14:01:43 #info sandbergja is Jane Sandberg, Linn Benton Community College (Albany, OR) 14:01:45 #info rsoulliere is Robert Soulliere, Mohawk College 14:01:50 #info jihpringle is Jennifer Pringle @ BC Libraries Cooperative 14:02:12 #info stompro is Josh Stompro @ Lake Agassiz Regional Library System (MN) 14:02:22 #info snigdha26 is Snigdha Dagar, OPW candidate 14:02:55 #info bshum is Ben Shum, Bibliomation 14:02:56 heads up there is another meeting that start at 3:00 PM EST 14:02:58 today 14:03:17 #topic old business 14:03:30 sorry, we shoudl do content coordinator reports 14:03:40 #topic coordinator reports (if any) 14:03:43 #info kmlussier is Kathy Lussier, MassLNC 14:03:57 #info ericar is Erica Rohlfs @ Equinox 14:04:00 #topic Release Coordinator report 14:04:20 #info The Release Notes for 2.7.0 are done 14:04:37 kmlussier++ 14:04:46 #info I do plan to add links from the release notes to the documentation for the new feature, but we're still waiting on some 2.7 documentation. 14:04:48 End of report. 14:05:10 kmlussier++ 14:05:33 kmlussier: do you know what is missing? 14:05:54 Also, I just wanted to mention that there were very few features missing from the release notes on my first pass, so the developers did a good job of adding the release notes as they submitted code. 14:05:56 developers++ 14:06:21 developers++ 14:06:38 yboston: Just a few things missing, I think. http://wiki.evergreen-ils.org/doku.php?id=evergreen-docs:2.7_needs 14:07:47 should we check in on each other between now and the next meeting to make sure we are done with 2.7? 14:08:20 yes, good idea 14:09:13 I have updates for a couple of the items. I asked krvmga to send me his Content Cafe docs so that I could review them and put them in a working branch. 14:09:52 kmlussier: do you have them now? or still waiting? 14:09:54 kmlussier: do you mind sending out another emial to check in in a couple of weeks? if not we can wait for the next meeting, by putting an item in the agenda again for 27 14:10:01 And I have on outstanding item for MARC Stream Importer. I have a colleague who did some rough documentation a while back that I was going to use. But I won'g get to it for at least another week. 14:10:18 remingtron: Still waiting. I'll see him Monday and can remind him again. 14:10:29 yboston: Sure 14:10:48 kmlussier: sounds fine. if you need a hand reviewing or pushing things in, let me know 14:11:02 remingtron: Thanks! I'll probably take you up on that offer. 14:11:19 #action kmlussier will check in on list to help move along pending 2.7 docs 14:11:52 #action yboston will add agenda entry to November DIG meeting to check in on pending 2.7 docs 14:12:45 if neccessary, in a couple of weeks we can just find another volunteer to finsish was was started on stream importer (I could volunteer then) 14:13:20 should we move on to see if Robert wants to report soemthing? 14:13:26 yes 14:13:29 #topic Conversion Coordinator Report 14:13:37 #info 2.7 docs should be built in the next couple of days from the new rel_2_7 branch. One faulty image is causing a delay but should be an easy fix. 14:14:00 rsoulliere: I'll try to backport that fix right now 14:14:15 remingtron++ 14:14:25 That is all I had. 14:14:33 rsoulliere++ 14:15:12 in the interest of time, I would like to start with new business 14:15:18 rsoulliere++ 14:15:25 rsoulliere++ 14:15:29 #topic new business 14:15:36 #topic Review of EG Upgrading Instructions (Robert) 14:16:17 I was discussing this with rsoulliere earlier today 14:16:26 Remingtron addressed the issue nicely by adding a note in the docs. 14:17:19 do you have a link or commit has for what he added? 14:17:53 it was July 10 or so 14:18:04 I'll look for a link 14:18:15 the date is fine for now 14:18:34 #link http://git.evergreen-ils.org/?p=Evergreen.git;a=commit;h=28a5085fd645c9470b852c9700661dbe4cbddf18 14:18:34 [evergreen|Remington Steed] Documentation: Upgrade instructions examples - 14:19:22 I have never done an upgrade so I have not been able to help with testing those instructions so far. thanks rsoulliere and remingtron for working on this 14:19:28 And here it is in the docs: http://docs.evergreen-ils.org/2.6/_upgrade_the_evergreen_database_schema.html 14:19:32 anything else to add or any questions from others? 14:21:08 OK, I will move on 14:21:33 #topic 2014 DIG hack-a-way post-mortem (Yamil) 14:21:49 (I am skipping the topic on 2.7 since we spoke about it already) 14:22:15 I am personally drwaing a blank on anything that I had pending from the hack-a-way 14:22:36 yboston: It was a great day. Fun was had by all! 14:22:43 is anyone waiting for me to push any code to the repo for them? 14:22:54 yboston: it felt like it was really productive 14:22:56 is this the first time we speak of the DIG hack-a-way since it happened? 14:23:11 yboston: I think this is the first time 14:23:18 Yes 14:23:27 I thought it was the best one so far 14:23:55 I am glad that since the last one we we severla small adjustments to our practices to improve our success 14:24:02 like just focusing on 2.7 14:24:35 it was helpful how many more peopel are usign git or Github one way or another 14:25:02 it's exciting to see people participating so much! 14:25:22 the next time we plan to be together physically again will be at the next conference in May 14:25:56 should we try for at least a digital hackaway before the next release, whenever that is? 14:25:58 unless we want to try another one earlynext year 14:26:00 might be before the conf 14:26:40 I am open to another event, even if it is remotely or just half a day befoer the next release 14:27:21 we can just wait to see what the developers decide in the next couple of months 14:27:46 they might want to stick to a February/March release date liek they have been doing lately 14:27:52 agreed. we'll address it when 2.8 release is scheduled 14:28:05 Unless we wanted to spend a day focusing on web client docs 14:28:15 kmlussier: very true 14:28:18 oooooo, good point 14:28:43 well, let's discuss that on the list 14:29:13 I know I'll be doing some documentation while testing, but I don't know how far I'll get. 14:29:43 jihpringle volunteered to help with preview web client docs 14:29:44 who would like to follow up on the list to get ideas for how to tackle web client docs 14:29:46 ? 14:29:54 kmlussier: let's coordinate 14:30:02 remingtron: Sure, sounds good. 14:30:12 yboston: I'll take the lead 14:30:15 OK 14:30:25 are we going to have a separate set of docs for the web client or a section in 2.7or 2.8? 14:30:48 #action remingtron will start a thread on DIG list on documenting the web client 14:31:02 jihpringle: I think in 2.7 and 2.8, etc. 14:31:09 but that could change 14:31:30 I just wonder at how long that will get as more module are done 14:31:33 I think a section makes the most sense. 14:31:39 good question, though I doubt we can answer it today 14:32:06 do we want to discuss it on the list and then decide in November? 14:32:16 we can contribute docs to it until we know where to put them 14:32:19 BTW, we are just past the 30 minute mark 14:32:20 can = can't 14:32:43 jihpringle: yeah, let's discuss on the list and revisit at next mtg 14:32:50 * kmlussier agrees that a section makes the most sense. 14:33:06 sounds like we'll start with a section in 2.7 14:33:28 It will get long, but we'll eventually be getting rid of the old docs once the old client is deprecated. 14:33:31 or a section in master? 14:33:40 thanks all for the input! 14:33:47 If the preview is available in 2.7, then it probably should be in 2.7 14:33:48 yboston: yeah, 2.7 and master both 14:33:59 should we move on? or we can continue too 14:34:00 master will change as the new version changes 14:34:06 I'm happy to move on 14:34:11 +1 14:34:46 #idea hack a DIG hack-a-way just for the new web client 14:35:06 #idea consider having another DIG hack-a-way nefore the next major EG release in 2015 14:35:13 #topic Feedback to OPW candidate's doc site ideas (Kathy, Snigdha) 14:35:54 #link http://markmail.org/thread/kjddts4zod2uwbe6 14:36:06 first of all I would like to welcome our OPW intern candidate snigdha26 14:36:17 snigdha26: welcome! 14:36:26 and perhaps other OPW candidates that might be lurking 14:36:52 I really liked snigdha26's ideas, especially the collapsible TOC over on the left. 14:36:53 yboston: remingtron: thanks :) 14:37:17 kbutler: +1 to that idea 14:37:27 kbutler: +1 14:37:33 I also like the collapsible TOC idea. 14:37:35 I know snigdha26 received some feedback on her ideas in the e-mail thread, but I thought it might be good to see if others have feedback. It will help her has she pulls together her OPW application. 14:37:45 it is ice to get a fresh perspective from someone from the outside 14:37:49 *nice 14:38:17 Also, if people have other suggestions, now is a perfect time to bring them up. :) 14:38:51 I've posted to the list about changing how the search scoping works.. no responses though. 14:38:54 I love the idea for adding a "Get Help" box at the top 14:39:20 stompro: I liked that idea as well. It would make so much more sense than searching everything by default. 14:39:24 stompro: I like the idea, but will depend on how easy it is to accomplish via Google custom search 14:39:43 stompro: I like the idea of choosing whether to search this release or all docs. 14:39:45 stompro: I did respond on the thread, but I think google marked that as spam 14:39:46 I think Google custom search can do it, with the pro version. 14:39:52 stompro: and how much time rsoulliere can put into it. If you figure out the details, send it to the DIG list 14:40:06 I wasn't sure about the "search the entire site" option since it would replicate what's on the Evergreen home page. 14:40:12 stompro: I liked the ides too, but I also have remingtron's reservation. though we just need a little research to find out what can be done 14:40:57 I'll look into it some more and post to the list. 14:41:10 stompro++ 14:41:59 Not sure about adding user comments to the docs 14:42:02 I'm also in favor of taking a look at the documentation organization. As it's grown, we may find there are some topics better grouped together that are not together now. 14:42:11 I also like the FAQ idea, but populating it might be hard, we need to know which questions are frequently asked. And there are other FAQ's on the evergreen site that maybe already cover some things. 14:42:39 In the realm of other suggestions, one thing I like about PostgreSQL's doc site is that it clearly identifies which release the docs apply to (in case you arrived through a Google search) and has links along the top to quickly jump to the same section for other releases. 14:43:06 kmlussier: +1 to that! 14:43:23 stompro: One thing I was thinking is we could maybe tie it closely together with the Evergreen site. I think there is a FAQ plug-in for WordPress (can't recall if we're using it). 14:43:26 I agree with kbutler , we might want to rethink the overall organization, but it might require having another docs server set up to test out new re-orgs of the content for us to see, wihtout impacting the main docs server 14:43:39 kbutler, I've wondered why there are 3 sections on tpac and several sections on Acquisitions. A reorg would be good. 14:44:13 +1 to a reorg 14:44:25 stompro: That's partially due to the Evergreen in Action docs being added without replacing the existing docs. I think if those were more explicitly called out as being "Evergreen in Action" docs, it would make more sense to the user. 14:44:57 would someone like to give a try at reorganizing the docs? Even baby steps are good. Let's start a wiki page with Table of Contents 14:45:09 In terms of a docs server, I e-mailed with rsoulliere a few weeks ago about trying to replicate his set up on one of the MassLNC VM's 14:45:11 +1 to that idea 14:45:23 (wiki with table of contents) 14:45:43 +1 to wiki table of contents page to list ideas 14:45:49 I don't know if it could serve that purpose permanantly, but I think it will be needed if the doc project is one that's selected for OPW 14:46:22 hi I'm 2n year Student of MCA in NIT Durgapur. I'm interseted in ccontributing in Docccumentation part of Evergreen. Could anybody help in this regard? 14:46:50 vrani: welcome! 14:46:52 kmlussier: csharp told me to contact gmcharlt about formally requesting a permanent VM for EG community purpoes to be used by DIG 14:47:00 to be hosted by PINES 14:47:02 Welcome vrani! You arrived at a good time. We're holding a documentation meeting right now. :) 14:47:14 awesome :) 14:47:19 * gmcharlt perks up 14:47:33 vrani: I will send you a private message right now to ask for more info 14:47:44 vrani: I am one of the mentors for OPW 14:47:44 sounds good :) 14:47:55 In case the wiki page with TOC is implemented, I could help out with it too and based on the ideas, see how the documentation could be re-organized 14:47:57 hi yboston 14:48:11 yboston: I'm listening re VM - or feel free to email me 14:48:28 snigdha26: sounds good. I will start the wiki page for reorganization ideas 14:48:29 I'll send you the email I started at the hack-a-way that I never sent :) 14:48:48 BTW, we have 12 minutes left in this meeting 14:49:13 remingtron: I'll work with you on that then 14:49:23 snigdha26++ 14:49:23 vrani: You may want to read up in the discussion we've just had about doc site ideas. http://irc.evergreen-ils.org/evergreen/2014-10-02 14:50:25 vrani: on that chat log, you can start at about 14:00 14:50:40 ok thanks alot :) 14:51:42 how do we want to proceed at this point? 14:51:56 we talked about brinstorming on a re-orf 14:52:00 *re-org 14:52:11 with a wiki 14:52:15 Thanks for the feedback everyone :) 14:52:26 remingtron: can I put you down for that action of creating the wiki? 14:52:32 yboston: yes 14:52:52 #action remingtron will create a wiki page to collect ideas for a docs re-org 14:52:58 I think we should keep discussing snigdha26's ideas on that email thread 14:53:12 we talked about setting up a test server to be used for OPW purposes, and a few other experiments 14:53:14 snigdha26++ Thanks for the ideas! 14:53:32 I can assign that task to me and kmlussier ? is that OK? 14:54:04 Does it need to be assigned? snigdha26 already started the thread. People should feel free to continue offering feedback and ideas, I think. 14:54:12 did we want to focus on a couple of the ideas first liek the search changes or testing the addition of a (collapsible) TOC tot he pages? 14:54:59 kmlussier: I meant about following up with a docs test server 14:55:04 Oh, sorry. 14:55:08 * kmlussier was confused. 14:55:32 BTW, the next meeting, Academics for Evergeen, will start in 5 minutes 14:55:58 Yes, you should assign it to the two of us. And wrap up this meeting to make way for the academics. :) 14:56:15 #action yboston kmlussier will work to allocate a VM for use by DIG memebres and OPW intern for DIG work 14:56:28 yboston: regarding the collapsible TOC - Im not sure if it can be done in asciidoc, but I can definitely do that in HTML 14:56:30 kmlussier++ #VM 14:56:40 we need to stop, but if anyone has other questions or comments, bring them up on the DIG list for now 14:56:50 #stopmeeting 14:56:57 remingtron: No karma until I actually figure out how to do it. : \ 14:57:00 end 14:57:01 #endmeeting