(I think this is part of the drupalorg module... if not where is it?)
On every function page on api.drupal.org, there is a "file an issue link", which takes you to a node/add page such as:
http://drupal.org/node/add/project-issue/drupal?title=Documentation%20pr...
I end up changing the issue titles a lot, to make them more meaningful, and at least one frequent issue filer didn't realize it was good for the person filing the issue to change the title to something more meaningful.
It would be better if the automatically-generated body changed from "Describe the problem you have found" (after the link to the API page that it came from, which is very helpful) to "Describe the problem you have found (and change the issue title to something more descriptive)".
Or we could change the title of the generated issue from "Documentation problem with ..." to "(description here) problem with ...", or something that gets the point across that the function name
I'd be happy with either -- just something that gets the point across that the issue filer should edit the title.
Figure out what to do, and implement/deploy it.
Issue link will go to a slightly different URL.
None.
| Comment | File | Size | Author |
|---|---|---|---|
| #7 | remove_documentation_issue_title-1387724-7.patch | 1.43 KB | aaronott |
| #4 | remove_documentation_issue_title-1387724-4.patch | 1.42 KB | aaronott |
Comments
Comment #1
drummhttp://drupalcode.org/project/drupalorg.git/blob/125a5448b99cf815ed26ec7... makes the link. I'm okay with either proposed solution.
Comment #2
jhodgdonOK. I'll try to make a patch sometime soon... unless someone else wants to take this on.
Comment #3
drummLet's see what the novice tag does.
Comment #4
aaronott commentedPerhaps a bit much but this patch removes the title all together then asks for a descriptive title in the auto text of the body. I changed the body portion to say:
GIve a descriptive title relating to @label, then describe the problem you have found:
This makes a point to tell the issue filer what needs to be done and doesn't allow them to submit the issue until a title is actually entered in.
Thoughts?
Comment #5
aaronott commentedProbably should have changed this to needs review.
Comment #6
jhodgdonHuh. That's an interesting idea. :) I like it! But can we say:
Enter a descriptive title (above) ...
rather than
Give a descriptive title...
or something like that? I don't think "give" is the right verb, and I don't think it would hurt to point out that the title is above. Thoughts?
Comment #7
aaronott commentedI agree that 'Enter' sounds better than 'Give' and at first I didn't think we needed to tell people where to enter the title but then started thinking we'd probably see a number of posts that had the title in the body field.
So I did change both of the areas you suggested here.
Thanks!
Comment #8
jhodgdonThat looks good to me! I have not actually tested it because I don't have an API scratch site sitting around, but it should work. Thanks a bunch!
Comment #9
jhodgdonComment #10
jhodgdonThis patch still applies, at least to the copy of drupalorg that I have on docs-manage-drupal.redesign.devdrupal.org right now.
I'd still like to see it applied/deployed sometime. Thanks!
Comment #11
drummCommitted & deployed.
Comment #12
drummUntag