Inkscape

Bug #1774404
Comment #14

Comment 14 for bug 1774404

Revision history for this message

Brynn (brynn4inks-deactivatedaccount) wrote on 2018-07-12:

#14

Ok, here's an extremely rough draft: https://inkscape.org/en/report-bugs-2-edit/

The current page is here, for comparison: https://inkscape.org/en/contribute/report-bugs/

Yes, the footnotes are crazy, and to be honest, college was so long ago, I can't remember all the rules. In some places, I used asterisks, in another place, I put a traditional superscript "1". I guess the asterisks are not really footnotes per se. They need to be within the same h2 heading section, rather than the bottom of the page. (Can't think what the word for that is, BS class of '81)

You'll also see some color highlighted text, which are a couple of questions I have about whether to include that particular text at all. Just match the color of the text with the color of my question.

I have no doubt that others can improve on not just the footnotes, but the text and language.

Originally, I wanted to just have short bullet lists at top, with explanations and descriptions below. But I just fear that some newbies will be in such a hurry that they won't see important tips, such as discussing the problem with other users, before making the report. And other things.

So instead, I used bold text for the main steps. So people in a hurry can just see the bold, and get there fast. Hopefully new users will take the time to read in between the bold.

But I'm certainly not married to this, and fully expect it needs more work -- which I completely welcome!

At some point, I want to post about this change to the Docs mailing list, so that others on the website team can review it (who might not have seen this bug report). I'm not sure if it's ready for that yet? But if you think so, let me know, and I'll make the post.

I've left out the part you suggested about the life cycle of a bug, which I agree needs to be on a separate page (although linked would probably be good). And I also left out the GDB part, which I hardly understand at all. But you had suggested that it doesn't really fit on this page, so I left it out.

I'm thinking that the section "Other bug reporter responsibilities" maybe should go under "Make the bug report..." section? Easy to do, if you agree. Maybe "Why is this important" section should also go below "Make the bug report"??

Do you have edit permissions on the website? If so, you're welcome to hack away at it yourself. Or else just tell me what changes you want. Or would you prefer to switch to email or something else?

Ok, here's an extremely rough draft:  https://inkscape.org/en/report-bugs-2-edit/

The current page is here, for comparison:  https://inkscape.org/en/contribute/report-bugs/

Yes, the footnotes are crazy, and to be honest, college was so long ago, I can't remember all the rules.  In some places, I used asterisks, in another place, I put a traditional superscript "1".  I guess the asterisks are not really footnotes per se.  They need to be within the same h2 heading section, rather than the bottom of the page.  (Can't think what the word for that is, BS class of '81)

You'll also see some color highlighted text, which are a couple of questions I have about whether to include that particular text at all.  Just match the color of the text with the color of my question.

I have no doubt that others can improve on not just the footnotes, but the text and language.

Originally, I wanted to just have short bullet lists at top, with explanations and descriptions below.  But I just fear that some newbies will be in such a hurry that they won't see important tips, such as discussing the problem with other users, before making the report.  And other things.

So instead, I used bold text for the main steps.  So people in a hurry can just see the bold, and get there fast.  Hopefully new users will take the time to read in between the bold.

But I'm certainly not married to this, and fully expect it needs more work -- which I completely welcome!

At some point, I want to post about this change to the Docs mailing list, so that others on the website team can review it (who might not have seen this bug report).  I'm not sure if it's ready for that yet?  But if you think so, let me know, and I'll make the post.

I've left out the part you suggested about the life cycle of a bug, which I agree needs to be on a separate page (although linked would probably be good).  And I also left out the GDB part, which I hardly understand at all.  But you had suggested that it doesn't really fit on this page, so I left it out.

I'm thinking that the section "Other bug reporter responsibilities" maybe should go under "Make the bug report..." section?  Easy to do, if you agree.  Maybe "Why is this important" section should also go below "Make the bug report"??

Do you have edit permissions on the website?  If so, you're welcome to hack away at it yourself.  Or else just tell me what changes you want.  Or would you prefer to switch to email or something else?