data-centric-computing / dcic-public

Repository for (for now) filing bug reports about DCIC.
19 stars 2 forks source link

[DCIC]: what about book issues? #14

Closed shriram closed 2 years ago

shriram commented 2 years ago

Contact Details

shriram@gmail.com

What's your suggestion?

https://github.com/data-centric-computing/dcic-public/issues/new/choose does not include "issue with book", which is probably the most common kind. That should probably be the top option. Any reason not to have that?

kfisler commented 2 years ago

I agree from a labeling standpoint. That said, I would still want the webpage corresponding to the book chapter -- that is helpful for me in identifying which scrbl file I need to open for the editing. Should we maybe just rename the "Webpage problem" form to say "Webpage or book text problem", then have the description indicate to use it for problems with the text or a specific section?

shriram commented 2 years ago

I think the Web is just the current presentation; the book is the semantic content. So I think there should be a clear label for issues with the BOOK. That can ask people for the Web URL, chapter number, etc., etc., whatever is needed to figure out where in the book they are referring.

One could also imagine separating Book issues from Web issues: eg, something to do with formatting, color, cookies, etc.

debanjan16 commented 2 years ago

I agree with @shriram here. Web issues are displaying issues. I was wondering where to put the typo issue. Typo issue clearly goes under issue with the book content.

kfisler commented 2 years ago

Fine with me. I'm assuming whoever set up the issue tracker will make the new category for book issues. Just ask for the page url as we do for web issues.

On Fri, Jan 7, 2022 at 11:07 AM Shriram Krishnamurthi < @.***> wrote:

I think the Web is just the current presentation; the book is the semantic content. So I think there should be a clear label for issues with the BOOK. That can ask people for the Web URL, chapter number, etc., etc., whatever is needed to figure out where in the book they are referring.

One could also imagine separating Book issues from Web issues: eg, something to do with formatting, color, cookies, etc.

— Reply to this email directly, view it on GitHub https://github.com/data-centric-computing/dcic-public/issues/14#issuecomment-1007529727, or unsubscribe https://github.com/notifications/unsubscribe-auth/AALO7SM4LQT53DQOK7AVK6DUU4FTDANCNFSM5LNUGUBQ . You are receiving this because you were assigned.Message ID: @.***>

shriram commented 2 years ago

@kfisler Please check https://github.com/data-centric-computing/dcic-public/issues/new/choose and let me know if you want to see any changes.

kfisler commented 2 years ago

Do we need to ask about the browser version for a book issue? Or is that precautionary as some web issues might get reported as book issues?

Other than that, LGTM

Message ID: <data-centric-computing/dcic-public/issues/14/1007997974@ github.com>

shriram commented 2 years ago

It's an optional field and doesn't hurt. You never know. It could be a rendering issue that is presented as a typo, and the rendering could be a function of the browser.