Changes between Version 1 and Version 2 of Developer/DocsProjects

Apr 19, 2019, 4:33:39 PM (6 months ago)
Gedare Bloom

Add more mud.


  • Developer/DocsProjects

    v1 v2  
    55Welcome! Whether you're here because of [wiki:GSoD Google Season of Docs (GSoD)] or just want to scratch an itch, we invite you to peruse our documentation projects and ask about them on the [wiki:TBR/Website/RTEMSMailingLists  RTEMS devel mailing list] or [wiki:Developer/IRC IRC].  If you plan to submit a proposal to do something for the RTEMS Project as part of GSoD, see [wiki:GSoD/GettingStarted  Getting Started for GSoD Technical Writers].
    7 == Project Ideas List ==
     7== Documentation Project Ideas List ==
    99Open projects are held in Trac as Trac tickets. If one of the projects sounds interesting, but lacks detail, ask on the [ RTEMS Devel mailing list (subscribe first)] for details, and we can all help scope the project. The owner field indicates a possible primary mentor for the project.
    1111The list in no specific order is:
    1212[[TicketQuery(status!=closed, keywords~=SoC docs, format=table, col=summary|owner, order=priority|id)]]
     14=== Adding New Documentation Projects ===
     15Open projects are managed as Trac Tickets. To create a new project:
     17 * Create a new ticket by clicking on [/newticket?type=project&milestone=Indefinite New Ticket].
     18 * The Summary field of the ticket is the title of the open project.
     19 * The Description field of the ticket is the project detail. Please use the [ WikiFormatting] to enhance the readability of the project's details. If you are not sure please review existing open projects as an example.
     20 * Set the Type field of the ticket as "project". This would have already been filled if you clicked on the New Ticket link above.
     21 * Set the Milestone field to be "Indefinite". This would have already been filled if you clicked on the New Ticket link above.
     22 * One of the potential primary mentors of the project should be mentioned in the Owner field and you should CC the rest of the mentors. If no mentors are mentioned, keep the fields blank.
     23 * The Keywords field should be set to "SoC doc" denoting a Season of Docs project.
     24 * Select an appropriate component for the Component field, this will normally be "doc" for GSoD projects.
     26If you are unsure about anything, please ask on the [ RTEMS Users mailing list].
     28== Other Documentation Projects ==
     30The following are documentation-related tasks that have not yet been scoped for a GSoD project, but might be sufficient for a GSoD or may be included as part of one.
     32[[TicketQuery(status!=closed, component=doc, format=table, col=summary|owner, order=priority|id)]]