#157 ✓resolved
T.J. Crowder

Need link to documentation project from contribute page

Reported by T.J. Crowder | April 2nd, 2010 @ 07:01 PM

Since documentation tickets get closed as invalid when reported in the Lighthouse project linked from http://prototypejs.org/contribute, that page needs a link to this project instead, with clear guidance to users which project to submit which kinds of error reports to. (I don't think it'll work, people don't read, but then at least you have the comeback that it's there and they just didn't read it. And who knows, if they're reporting a documentation bug, maybe they do read, unlike most users.) Better yet, re-combine the two projects and use tags, ticket bins, etc., instead. Expecting users to triage is asking for mis-reported tickets.

(Damn, extraneous "s" in title and can't fix it. Should be "project" singular. sigh Sorry.)

Comments and changes to this ticket

  • Tobie Langel

    Tobie Langel April 3rd, 2010 @ 01:11 AM

    • State changed from “new” to “enhancement”
    • Title changed from “Need link to documentation projects from contribute page” to “Need link to documentation project from contribute page”

    For the record, they don't get closed as invalid. Yours got closed as invalid. Other people get a nicer treatment! :P

    Your welcome to find, organise and maintain a better solution, TJ, this just seemed the most appropriate one at the time.

    Oh, and fixed your title, too (it's the small, really hard to spot link at the bottom of the page called "Change title…").

  • T.J. Crowder

    T.J. Crowder April 3rd, 2010 @ 06:41 AM

    @Tobie: Thanks for fixing the title. You're right, that's a hard to spot link.

  • T.J. Crowder

    T.J. Crowder April 3rd, 2010 @ 06:42 AM

    Sorry, didn't mean to change the priority.

  • T.J. Crowder

    T.J. Crowder April 3rd, 2010 @ 07:16 AM

    • State changed from “enhancement” to “resolved”
    • Assigned user changed from “Samuel Lebeau” to “T.J. Crowder”

    Fixed it: http://prototypejs.org/contribute

    If you need to edit it, here's the Mephisto link

    The blasted thing wouldn't publish until I set the date to yesterday. The time on the box apparently isn't GMT, and I have no idea what it actually is (vague recollection...Pacific time?)

    Changes:

    • Call out the two projects at the top
    • Edit the outdated "API documentation enhancements" section at the bottom to mention PDoc, remove the outdated Mephisto markup example, and link to the source on github by way of examples
  • T.J. Crowder

    T.J. Crowder May 14th, 2010 @ 07:43 AM

    I've attached the old version of the article (revision 9 in Mephisto), the new version (revision 12 -- I had a couple of false starts), and a diff of them to the Lighthouse ticket. There was no change to the excerpt.

    Glad we're switching to git for this stuff.

Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.

New-ticket Create new ticket

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile ยป

Shared Ticket Bins

Attachments

Pages