Re: [GNC-dev] Register Documentation Improvements (was Re: [GNC] Column widths again)
On Mon, 27 Aug 2018 11:14:28 -0500 Rob Gowin wrote: > On Mon, Aug 27, 2018 at 7:50 AM, Mike Evans wrote: > > > > Hi Rob > > > > Referring to your mail of 2015-09-01 you "put the XSL file and a python > > script to run the conversion process in a repository at > > https://github.com/codesmythe/asciidoc-conversion.; > > > > This no longer exists, can you make it available again? Unless you'd > > rather not of course. > > > > Mike Evans > > > > And by not-so-popular demand, that repository is back. :-) > > I haven't touched that code since the 2015 discussion, but hopefully you > can some use out of it. > > Regards, > > Rob Forked. So now there are two. Mike E ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: [GNC-dev] Bugzilla Structure
One could, but I agree that a “General” component is better, so I’ve made one. I think David’s 777893 belongs in the T, though, and he’s already moved it there. Regards, John Ralls > On Aug 27, 2018, at 10:39 AM, Derek Atkins wrote: > > Another option is to open bugs in each of the affected areas and reference > each other properly. > > -derek > > > On Mon, August 27, 2018 1:30 pm, David T. via gnucash-devel wrote: >> Thanks, John; I found that about ten minutes after I sent it out! >> >> I do still think that a bug that crosses documents causes categorization >> issues. Adrien’s suggestion to add a General (I paraphrase) option might >> be useful. >> >> David >> >>> On Aug 27, 2018, at 11:09 AM, John Ralls wrote: >>> >>> >>> On Aug 27, 2018, at 7:28 AM, David T. via gnucash-devel wrote: Hello, I was just trying to track down the status of documentation bug 777893, and was stymied for a bit. A bit of history: I raised the bug to induce the addition of information about the SQL formats. Subsequently, I wrote a section for inclusion in the Guide, which was submitted 10 days ago as Pull Request #109. Today, I wanted to go add the PR # to the bug, and clicked my way to the bugzilla section for the Guide, only to not find the bug in question. Searching by bug number shows that the bug was entered under Help, rather than Guide. This situation points out that breaking the bugs out to this level of granularity can have negative effects: first, it forces a reporter to decide on the appropriate document for a bug, rather than focus on the problem in question; second a user looking for these bugs must discern the specific document to which a given bug was assigned in order to locate said bug; third, it causes difficulty if a given bug recommends changes to more than one piece of documentation, as this bug does—which doc does the bug get assigned to? While it may have seemed an advance to be able to structure our bugs to cover specific documents, I wonder at the choice at this point, and ask how difficult it would be either to change the structure itself, or find a way to allow users the option of seeing all Doc bugs in an aggregated screen? >>> >>> Yeah, don’t select a component when you do the search. >>> >>> Regards, >>> John Ralls >>> >> >> ___ >> gnucash-devel mailing list >> gnucash-devel@gnucash.org >> https://lists.gnucash.org/mailman/listinfo/gnucash-devel >> > > > -- > Derek Atkins 617-623-3745 > de...@ihtfp.com www.ihtfp.com > Computer and Internet Security Consultant > ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: [GNC-dev] Bugzilla Structure
Another option is to open bugs in each of the affected areas and reference each other properly. -derek On Mon, August 27, 2018 1:30 pm, David T. via gnucash-devel wrote: > Thanks, John; I found that about ten minutes after I sent it out! > > I do still think that a bug that crosses documents causes categorization > issues. Adrien’s suggestion to add a General (I paraphrase) option might > be useful. > > David > >> On Aug 27, 2018, at 11:09 AM, John Ralls wrote: >> >> >> >>> On Aug 27, 2018, at 7:28 AM, David T. via gnucash-devel >>> wrote: >>> >>> Hello, >>> >>> I was just trying to track down the status of documentation bug 777893, >>> and was stymied for a bit. >>> >>> A bit of history: I raised the bug to induce the addition of >>> information about the SQL formats. Subsequently, I wrote a section for >>> inclusion in the Guide, which was submitted 10 days ago as Pull Request >>> #109. >>> >>> Today, I wanted to go add the PR # to the bug, and clicked my way to >>> the bugzilla section for the Guide, only to not find the bug in >>> question. Searching by bug number shows that the bug was entered under >>> Help, rather than Guide. This situation points out that breaking the >>> bugs out to this level of granularity can have negative effects: first, >>> it forces a reporter to decide on the appropriate document for a bug, >>> rather than focus on the problem in question; second a user looking for >>> these bugs must discern the specific document to which a given bug was >>> assigned in order to locate said bug; third, it causes difficulty if a >>> given bug recommends changes to more than one piece of documentation, >>> as this bug does—which doc does the bug get assigned to? >>> >>> While it may have seemed an advance to be able to structure our bugs to >>> cover specific documents, I wonder at the choice at this point, and ask >>> how difficult it would be either to change the structure itself, or >>> find a way to allow users the option of seeing all Doc bugs in an >>> aggregated screen? >> >> Yeah, don’t select a component when you do the search. >> >> Regards, >> John Ralls >> > > ___ > gnucash-devel mailing list > gnucash-devel@gnucash.org > https://lists.gnucash.org/mailman/listinfo/gnucash-devel > -- Derek Atkins 617-623-3745 de...@ihtfp.com www.ihtfp.com Computer and Internet Security Consultant ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: [GNC-dev] Bugzilla Structure
Thanks, John; I found that about ten minutes after I sent it out! I do still think that a bug that crosses documents causes categorization issues. Adrien’s suggestion to add a General (I paraphrase) option might be useful. David > On Aug 27, 2018, at 11:09 AM, John Ralls wrote: > > > >> On Aug 27, 2018, at 7:28 AM, David T. via gnucash-devel >> wrote: >> >> Hello, >> >> I was just trying to track down the status of documentation bug 777893, and >> was stymied for a bit. >> >> A bit of history: I raised the bug to induce the addition of information >> about the SQL formats. Subsequently, I wrote a section for inclusion in the >> Guide, which was submitted 10 days ago as Pull Request #109. >> >> Today, I wanted to go add the PR # to the bug, and clicked my way to the >> bugzilla section for the Guide, only to not find the bug in question. >> Searching by bug number shows that the bug was entered under Help, rather >> than Guide. This situation points out that breaking the bugs out to this >> level of granularity can have negative effects: first, it forces a reporter >> to decide on the appropriate document for a bug, rather than focus on the >> problem in question; second a user looking for these bugs must discern the >> specific document to which a given bug was assigned in order to locate said >> bug; third, it causes difficulty if a given bug recommends changes to more >> than one piece of documentation, as this bug does—which doc does the bug get >> assigned to? >> >> While it may have seemed an advance to be able to structure our bugs to >> cover specific documents, I wonder at the choice at this point, and ask how >> difficult it would be either to change the structure itself, or find a way >> to allow users the option of seeing all Doc bugs in an aggregated screen? > > Yeah, don’t select a component when you do the search. > > Regards, > John Ralls > ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: [GNC-dev] Register Documentation Improvements (was Re: [GNC] Column widths again)
On Mon, Aug 27, 2018 at 7:50 AM, Mike Evans wrote: > > Hi Rob > > Referring to your mail of 2015-09-01 you "put the XSL file and a python > script to run the conversion process in a repository at > https://github.com/codesmythe/asciidoc-conversion.; > > This no longer exists, can you make it available again? Unless you'd > rather not of course. > > Mike Evans > And by not-so-popular demand, that repository is back. :-) I haven't touched that code since the 2015 discussion, but hopefully you can some use out of it. Regards, Rob ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: [GNC-dev] Bugzilla Structure
> On Aug 27, 2018, at 7:28 AM, David T. via gnucash-devel > wrote: > > Hello, > > I was just trying to track down the status of documentation bug 777893, and > was stymied for a bit. > > A bit of history: I raised the bug to induce the addition of information > about the SQL formats. Subsequently, I wrote a section for inclusion in the > Guide, which was submitted 10 days ago as Pull Request #109. > > Today, I wanted to go add the PR # to the bug, and clicked my way to the > bugzilla section for the Guide, only to not find the bug in question. > Searching by bug number shows that the bug was entered under Help, rather > than Guide. This situation points out that breaking the bugs out to this > level of granularity can have negative effects: first, it forces a reporter > to decide on the appropriate document for a bug, rather than focus on the > problem in question; second a user looking for these bugs must discern the > specific document to which a given bug was assigned in order to locate said > bug; third, it causes difficulty if a given bug recommends changes to more > than one piece of documentation, as this bug does—which doc does the bug get > assigned to? > > While it may have seemed an advance to be able to structure our bugs to cover > specific documents, I wonder at the choice at this point, and ask how > difficult it would be either to change the structure itself, or find a way to > allow users the option of seeing all Doc bugs in an aggregated screen? Yeah, don’t select a component when you do the search. Regards, John Ralls ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: [GNC-dev] Bugzilla Structure
The Search function worked very well with the bug number and any combination of the terms in the title. (or just a single term) But certainly, there could be a ‘product’ that covers *all/miscellaneous/generic* documentation bugs that apply to multiple documents. So I entered this: https://bugs.gnucash.org/show_bug.cgi?id=796825 Regards, Adrien > On Aug 27, 2018, at 9:28 AM, David T. via gnucash-devel > wrote: > > Hello, > > I was just trying to track down the status of documentation bug 777893, and > was stymied for a bit. > > A bit of history: I raised the bug to induce the addition of information > about the SQL formats. Subsequently, I wrote a section for inclusion in the > Guide, which was submitted 10 days ago as Pull Request #109. > > Today, I wanted to go add the PR # to the bug, and clicked my way to the > bugzilla section for the Guide, only to not find the bug in question. > Searching by bug number shows that the bug was entered under Help, rather > than Guide. This situation points out that breaking the bugs out to this > level of granularity can have negative effects: first, it forces a reporter > to decide on the appropriate document for a bug, rather than focus on the > problem in question; second a user looking for these bugs must discern the > specific document to which a given bug was assigned in order to locate said > bug; third, it causes difficulty if a given bug recommends changes to more > than one piece of documentation, as this bug does—which doc does the bug get > assigned to? > > While it may have seemed an advance to be able to structure our bugs to cover > specific documents, I wonder at the choice at this point, and ask how > difficult it would be either to change the structure itself, or find a way to > allow users the option of seeing all Doc bugs in an aggregated screen? > > Cheers, > David > ___ > gnucash-devel mailing list > gnucash-devel@gnucash.org > https://lists.gnucash.org/mailman/listinfo/gnucash-devel ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
[GNC-dev] Bugzilla Structure
Hello, I was just trying to track down the status of documentation bug 777893, and was stymied for a bit. A bit of history: I raised the bug to induce the addition of information about the SQL formats. Subsequently, I wrote a section for inclusion in the Guide, which was submitted 10 days ago as Pull Request #109. Today, I wanted to go add the PR # to the bug, and clicked my way to the bugzilla section for the Guide, only to not find the bug in question. Searching by bug number shows that the bug was entered under Help, rather than Guide. This situation points out that breaking the bugs out to this level of granularity can have negative effects: first, it forces a reporter to decide on the appropriate document for a bug, rather than focus on the problem in question; second a user looking for these bugs must discern the specific document to which a given bug was assigned in order to locate said bug; third, it causes difficulty if a given bug recommends changes to more than one piece of documentation, as this bug does—which doc does the bug get assigned to? While it may have seemed an advance to be able to structure our bugs to cover specific documents, I wonder at the choice at this point, and ask how difficult it would be either to change the structure itself, or find a way to allow users the option of seeing all Doc bugs in an aggregated screen? Cheers, David ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: [GNC-dev] Register Documentation Improvements (was Re: [GNC] Column widths again)
On Thu, 23 Aug 2018 12:25:51 -0500 Rob Gowin wrote: > On Thu, Aug 23, 2018 at 11:40 AM, John Ralls wrote: > > > > > > > So a new thought: One of the core devs use pandoc to convert the DocBook > > source to one of the markup/markdown variants, do the necessary manual > > fixups and commit the result. If we want DocBook for some reason the build > > process would use pandoc to generate it. > > > > If we had GitHub-flavored markdown sources then > > https://github.com/gnucash/gnucash-docs would show rendered documentation > > and one could use the "preview" button to check basic layout; it would > > appear pretty similar to how the document would look in a PDF or eBook > > rendering. > > > > > Hmmm. Old thought. :-) I did all of this in the 2015 thread that Geert > referenced. (Except I did not use pandoc, and used Asciidoc has my markup > variant of choice.) A rendered version of the Tutorial and Concept Guide > can be found here: https://github.com/codesmythe/gnucash-guide-asciidoc. > For example, click on 'en' then on ch_cbook.adoc to see a rendered version. > Then on that page click on the 'Raw' to see the Asciidoc source. I'd also > worked out the flow changes to generate PDF, eBook, etc from the Asciidoc > sources. > > In > https://lists.gnucash.org/pipermail/gnucash-devel/2015-September/038997.html, > you asked for buy-in from the non-tech doc writers, and unfortunately, none > was found. :-( > > One thing that has changed in the interim is the availability of decent > editors that have a live-preview mode that will show the raw Asciidoc on > the left and the live-rendered result on the right. For example, Visual > Studio Code (available for Mac, Linux, Windows) has an extension for this: > https://marketplace.visualstudio.com/items?itemName=joaompinto.asciidoctor-vscode > (see the demo gif), and VS Code supports Git out of the box. > > Rob > ___ Hi Rob Referring to your mail of 2015-09-01 you "put the XSL file and a python script to run the conversion process in a repository at https://github.com/codesmythe/asciidoc-conversion.; This no longer exists, can you make it available again? Unless you'd rather not of course. Mike Evans -- GPG Key fingerprint = 0D8A 33A8 F7F8 733C 7519 2A56 DB8F 7CF1 C67B BC0F ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
