search

jquery / contribute.jquery.org

Developer documentation common to jQuery projects
https://contribute.jquery.org
Other
25 stars 76 forks source link

Please clarify documentation issues in "How to Report Bugs" -> Where to Report #132

Open Chealer opened 8 years ago

Chealer commented 8 years ago

I filed a ticket in the wrong ITS after consulting http://contribute.jquery.org/bug-reports/: https://github.com/jquery/jquery/issues/2704

After re-reading the section, I understand that I should have filed that ticket on https://github.com/jquery/api.jquery.com/issues But I also understand why I filed the ticket against jQuery Core, and I'm sure I won't be the only one.

Since choosing the wrong target seems to be a big problem (my ticket was simply closed), the section should clarify that the list is only for behavioral issues. Splitting in 2 sections ("Non-documentation issues" vs "Website issues") should suffice.

mgol commented 8 years ago

Thanks for the report! It would be good to have links to API sites' bug trackers there as well. What do you think, @jquery/content?

AurelioDeRosa commented 8 years ago

:+1: for including the links @mzgol

mgol commented 8 years ago

@Chealer Would you like to create a PR for that?

Chealer commented 8 years ago

@mgol, I prepare changes without being sure they will be applied only exceptionally, and I am confident this can be solved easily.

That being said, I looked at http://contribute.jquery.org/documentation/ and realized this does not indicate how to report issues in... contribute.jquery.org! Both http://contribute.jquery.org/documentation/ and http://contribute.jquery.org/bug-reports/ should be changed. At least one should link to the other.

The source can be seen on https://github.com/jquery/contribute.jquery.org/tree/master/pages. I am not familiar with that file format anyway.