Would it be worthwhile to use milestone for items that are documented but need to be translated to AsciiDocs? Since I'm only starting to get involved, I wouldn't have an idea of what type of volume that would be but I thought I'd throw the question out...
-----Original Message----- From: [email protected] [mailto:[email protected]] On Behalf Of [email protected] Sent: Wednesday, November 13, 2013 10:58 AM To: [email protected] Subject: OPEN-ILS-DOCUMENTATION Digest, Vol 67, Issue 8 Send OPEN-ILS-DOCUMENTATION mailing list submissions to [email protected] To subscribe or unsubscribe via the World Wide Web, visit http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation or, via email, send a message with subject or body 'help' to [email protected] You can reach the person managing the list at [email protected] When replying, please edit your Subject line so it is more specific than "Re: Contents of OPEN-ILS-DOCUMENTATION digest..." Today's Topics: 1. Re: Docs TOC is too long (Kathy Lussier) 2. Re: Guidelines for submitting documentation needs to Launchpad (Yamil Suarez) 3. Re: Guidelines for submitting documentation needs to Launchpad (Lazar, Alexey Vladimirovich) 4. Re: Guidelines for submitting documentation needs to Launchpad (Ben Shum) 5. Link for today's DIG AsciiDoc training (Yamil Suarez) 6. Re: [OPEN-ILS-DEV] Guidelines for submitting documentation needs to Launchpad (Lazar, Alexey Vladimirovich) ---------------------------------------------------------------------- Message: 1 Date: Tue, 12 Nov 2013 12:52:30 -0500 From: Kathy Lussier <[email protected]> Subject: Re: [OPEN-ILS-DOCUMENTATION] Docs TOC is too long To: [email protected] Message-ID: <[email protected]> Content-Type: text/plain; charset="iso-8859-1"; Format="flowed" +1 from me too. Thanks Remington! Kathy Kathy Lussier Project Coordinator Massachusetts Library Network Cooperative (508) 343-0128 [email protected] Twitter: http://www.twitter.com/kmlussier On 11/8/2013 10:37 AM, Dan Scott wrote: > > > On Nov 8, 2013 10:17 AM, "Remington Steed" <[email protected] > <mailto:[email protected]>> wrote: > > > > As I've been working more with the Evergreen docs, I've become aware > of the very long table of contents. Could we limit it to three levels > of headings, instead of the four levels it shows now? I am thinking > mostly of the main table of contents page, but maybe also the main > section pages. Once you get into a chapter, I think it's more useful > to have the fourth level of headings in the table of contents. Thoughts? > > Agreed. Looks like it should be possible to tackle at the transform > level per > http://www.methods.co.nz/asciidoc/faq.html#_how_can_i_include_chapter_ > and_section_tables_of_contents and > http://www.sagehill.net/docbookxsl/TOCcontrol.html (writers shouldn't > have to do anything different). > > > > _______________________________________________ > OPEN-ILS-DOCUMENTATION mailing list > [email protected] > http://list.georgialibraries.org/mailman/listinfo/open-ils-documentati > on -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://list.georgialibraries.org/pipermail/open-ils-documentation/attachments/20131112/7b54deeb/attachment-0001.htm> ------------------------------ Message: 2 Date: Tue, 12 Nov 2013 17:03:56 -0500 From: Yamil Suarez <[email protected]> Subject: Re: [OPEN-ILS-DOCUMENTATION] Guidelines for submitting documentation needs to Launchpad To: Documentation discussion for Evergreen software <[email protected]> Cc: Evergreen Development Discussion List <[email protected]> Message-ID: <[email protected]> Content-Type: text/plain; charset=us-ascii This looks like a great start. Yamil On Nov 12, 2013, at 11:40 AM, Kathy Lussier <[email protected]> wrote: > Hi all, > > Please excuse cross postings. > > Over the past few months, DIG has been discussing the use of Launchpad to > identify documentation needs. We've tried a couple of trial bugs to see how > the process works, and I think the process has gone well for those trial > bugs. However, the trials have also brought up some questions on how to tag > documentation bugs, how and when to use things like the Fix Released status, > etc. I thought it would be useful if we had some written guidelines to follow > for using Launchpad to track documentation needs. > > I posted a draft set of guidelines this morning at > http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:lp_docs. > > I'm hoping to get some feedback from fellow DIG members as well as from the > developers/bug wranglers who are already using Launchpad on a daily basis to > track coding needs. > > The one question I struggled with was the extent to which we want to use > Launchpad features like milestones, statuses, importance etc. In a previous > DIG meeting when this question was first raised, I recall that some of the > bug wranglers had recommended against using milestones for documentation (too > much of a maintenance overhead?), but is there a use for some of these other > fields? I think the "Assigned to" field can be useful for people who want to > indicate that they are working on a particular doc. > > I also plan to work today on a central wiki page that will provide direct > links to the documentation bugs, broken down by different functional areas > (circulation, system configuration, opac etc.) If we use consistent tagging > when submitting these Launchpad reports, we should be able to easily link > people to those documentation needs relevant to their area of interest. > > Let me know what you think! > > Kathy > ------------------------------ Message: 3 Date: Wed, 13 Nov 2013 14:58:31 +0000 From: "Lazar, Alexey Vladimirovich" <[email protected]> Subject: Re: [OPEN-ILS-DOCUMENTATION] Guidelines for submitting documentation needs to Launchpad To: Documentation discussion for Evergreen software <[email protected]> Cc: Evergreen Development Discussion List <[email protected]> Message-ID: <[email protected]> Content-Type: text/plain; charset="us-ascii" On 2013-11-12, at 10:40 , Kathy Lussier <[email protected]> wrote: > I think the "Assigned to" field can be useful for people who want to > indicate that they are working on a particular doc. That sounds like a good idea. Although, maybe there is a good reason why this field is not utilized by the devs at all. Aleksey Lazar IS Developer and Integrator - PALS http://www.mnpals.org/ ------------------------------ Message: 4 Date: Wed, 13 Nov 2013 10:04:43 -0500 From: Ben Shum <[email protected]> Subject: Re: [OPEN-ILS-DOCUMENTATION] Guidelines for submitting documentation needs to Launchpad To: Documentation discussion for Evergreen software <[email protected]> Cc: Evergreen Development Discussion List <[email protected]> Message-ID: <caap1cpu5w79jt759aobwfdbvvnfrbau3ootecn1yksfttix...@mail.gmail.com> Content-Type: text/plain; charset=ISO-8859-1 Actually, we tend to make use of that "Assigned to" field in development to indicate that a particular bug is intended to be worked on by the assigned person. This is especially tied to use of the status "In Progress" with a particular person assigned to that bug. Additionally, sometimes reviewers assign bugs to themselves so that they let others know that they are actively reviewing the bug and not force duplication of efforts in bug work. -- Ben On Wed, Nov 13, 2013 at 9:58 AM, Lazar, Alexey Vladimirovich <[email protected]> wrote: > > On 2013-11-12, at 10:40 , Kathy Lussier <[email protected]> wrote: > >> I think the "Assigned to" field can be useful for people who want to >> indicate that they are working on a particular doc. > > That sounds like a good idea. Although, maybe there is a good reason why this > field is not utilized by the devs at all. > > Aleksey Lazar > IS Developer and Integrator - PALS > http://www.mnpals.org/ > > _______________________________________________ > OPEN-ILS-DOCUMENTATION mailing list > [email protected] > http://list.georgialibraries.org/mailman/listinfo/open-ils-documentati > on ------------------------------ Message: 5 Date: Wed, 13 Nov 2013 10:43:38 -0500 From: Yamil Suarez <[email protected]> Subject: [OPEN-ILS-DOCUMENTATION] Link for today's DIG AsciiDoc training To: Documentation discussion for Evergreen software <[email protected]>, General Evergreen List <[email protected]> Message-ID: <[email protected]> Content-Type: text/plain; charset=us-ascii Hello, I am sending out a link to my Youtube Channel home that should display a link to today's online training. Just hit refresh starting at 10:58 AM EST to see if this page has been updated. Wait for a video called "DIG AsciiDoc training" to show up, right now you only see videos I have liked. https://www.youtube.com/channel/UChdjnvQx_woWuwrKZKAymdw/videos?flow=grid&view=2 Thanks in advance, Yamil ------------------------------ Message: 6 Date: Wed, 13 Nov 2013 15:56:47 +0000 From: "Lazar, Alexey Vladimirovich" <[email protected]> Subject: Re: [OPEN-ILS-DOCUMENTATION] [OPEN-ILS-DEV] Guidelines for submitting documentation needs to Launchpad To: Evergreen Development Discussion List <[email protected]> Cc: Documentation discussion for Evergreen software <[email protected]> Message-ID: <[email protected]> Content-Type: text/plain; charset="iso-8859-1" On 2013-11-13, at 09:04 , Ben Shum <[email protected]> wrote: > Actually, we tend to make use of that "Assigned to" field in > development to indicate that a particular bug is intended to be worked > on by the assigned person. This is especially tied to use of the > status "In Progress" with a particular person assigned to that bug. > Additionally, sometimes reviewers assign bugs to themselves so that > they let others know that they are actively reviewing the bug and not > force duplication of efforts in bug work. > > -- Ben > > On Wed, Nov 13, 2013 at 9:58 AM, Lazar, Alexey Vladimirovich > <[email protected]> wrote: >> >> On 2013-11-12, at 10:40 , Kathy Lussier <[email protected]> wrote: >> >>> I think the "Assigned to" field can be useful for people who want to >>> indicate that they are working on a particular doc. >> >> That sounds like a good idea. Although, maybe there is a good reason why >> this field is not utilized by the devs at all. >> Ok, got it. So not "at all", but linked specifically to the "In progress" status. Maybe that's a model for DIG to consider as well. All the Evergreen LP bugs I've ever looked at did not use the "Assigned to" field. I always thought it was a little disorderly, but that's just me, I guess. Doesn't seem to matter in practical terms. Aleksey Lazar IS Developer and Integrator - PALS http://www.mnpals.org/ ------------------------------ _______________________________________________ OPEN-ILS-DOCUMENTATION mailing list [email protected] http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation End of OPEN-ILS-DOCUMENTATION Digest, Vol 67, Issue 8 ***************************************************** _______________________________________________ OPEN-ILS-DOCUMENTATION mailing list [email protected] http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
