Opened 8 years ago
Closed 8 years ago
#5490 closed enhancement (fixed)
Provide direct links in site-admin foreword documentation
Reported by: | Alexandre Franke | Owned by: | |
---|---|---|---|
Priority: | minor | Milestone: | |
Component: | documentation | Keywords: | |
Cc: | Parent Tickets: |
Description
"bug tracker" and "devel mailing list" should be direct links that the reader can follow since the sentences are call to action. Patch will follow.
Attachments (1)
Change History (6)
by , 8 years ago
Attachment: | 0001-Add-links-in-site-admin-documentation-foreword.patch added |
---|
comment:1 by , 8 years ago
Priority: | major → minor |
---|---|
Status: | new → review |
Type: | defect → enhancement |
comment:2 by , 8 years ago
Confirming that this patch applies cleanly, builds with Sphinx and looks good in the HTML docs.
comment:3 by , 8 years ago
Looks good to me, except for a couple of small nitpicks.
First, since we're modifying the bug tracker line anyway, we might as well place a period at the end to make a complete sentence.
- 1. Write up a bug report in the `bug tracker`_ + 1. Write up a bug report in the `bug tracker`_.
Second, I think there's subject/verb disagreement in the "More information" line. Generally in American English (which I'm assuming, possibly incorrectly, is the original language of the project), "information" is treated as a singular noun, not a plural noun. In this case, the sentence should say "information ... is" rather than "information ... are."
- More information about resources to contribute are available on + More information about resources to contribute is available on
afranke, do you mind if I make these modifications to the patch? Also, what name would you like us to enter for you in the AUTHORS file?
comment:4 by , 8 years ago
comment:5 by , 8 years ago
Resolution: | → fixed |
---|---|
Status: | review → closed |
Thanks Alexandre! I'll mark this as "for review" so that someone knows to take a look.