File an issue for this link
drumm - June 24, 2009 - 06:02
| Project: | API |
| Version: | 6.x-1.x-dev |
| Component: | User interface |
| Category: | feature request |
| Priority: | critical |
| Assigned: | Unassigned |
| Status: | closed |
Description
Not necessarily that wording, but the idea is we should have a link to a pre-filled create issue pages for API doc improvements. This will make contributing to documentation easier and encourage improving the code over commenting (#101308: Add commenting on API objects) about improvements. Probably will end up living in a drupalorg module, but should be in API if it can be made relatively generic.
#1
Must happen in next release.
#2
Now depends on #512824: Prepopulate project issue metadata from $_GET
#3
Here are my suggested prefills for filing an issue from an api.drupal.org page. I'm not sure it would fit in a URL, but this is my suggestion:
Project: Drupal
Version: [fill in with 7.x, 6.x, etc. depending on which tab is being viewed at that moment]
Component: documentation
Category: bug report
Leave Assigned, Priority, and Status as their defaults.
Title: Documentation problem with [function or topic name]
Suggested body: Pre-fill with "Pertains to [url the person was on]. (newline/newline) Please include a brief but complete description of what the problem with this documentation is, and if possible, what it should be changed to."
If that body won't fit in the URL, maybe this could be put in the instructions by the URL:
"When filing your issue, please include the URL of this page, a brief but complete description of what the problem with this documentation is, and if possible, what it should be changed to."
#4
Issue tag(s)?
#5
I don't think it needs any issue tags. If it's filed under Drupal project / documentation component, that pretty much covers it.
#6
Agreed with jhodgdon. This all looks good to me. We can always tweak it later if need be. :)
#7
Module that will be running this is attached.
#8
Committed to SVN since this is a site-specific module. Following the precedent of groups.drupal.org which doesn't keep their site-specific module in CVS.
#9
Automatically closed -- issue fixed for 2 weeks with no activity.