wiki:Developer/DocsProjects

Version 5 (modified by Gedare Bloom, on Apr 19, 2019 at 5:06:23 PM) (diff)

--

Documentation Projects

Welcome! Whether you're here because of 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 RTEMS devel mailing list or IRC. If you plan to submit a proposal to do something for the RTEMS Project as part of GSoD, see Getting Started for GSoD Technical Writers.

Overview

RTEMS is a real-time operating system used around the world and in space. RTEMS Project is proud to be applying to the inaugural Google Season of Docs 2019. You can feel free to send an email for questions specific to GSoD that one of our organization administrators or mentors will respond to.

Documentation Project Ideas List

Open 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. You can learn more about the mentors here.

The list in no specific order is:

Ticket Summary Owner
#3737 Improve Accessibility of User Manual Chris Johns
#3738 Refactor the Software Engineering Manual Joel Sherrill
#3739 Write a Tutorial for EPICS/RTEMS Gedare Bloom

Adding New Documentation Projects

Open projects are managed as Trac Tickets. To create a new project:

  • Create a new ticket by clicking on New Ticket.
  • The Summary field of the ticket is the title of the open project.
  • 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.
  • Set the Type field of the ticket as "project". This would have already been filled if you clicked on the New Ticket link above.
  • Set the Milestone field to be "Indefinite". This would have already been filled if you clicked on the New Ticket link above.
  • 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.
  • The Keywords field should be set to "SoC doc" denoting a Season of Docs project.
  • Select an appropriate component for the Component field, this will normally be "doc" for GSoD projects.

If you are unsure about anything, please ask on the RTEMS Users mailing list.

Other Documentation Projects

The following are documentation-related tasks that may not yet be scoped for a GSoD project, but might be sufficient for a GSoD or may be included as part of one: Open Documentation Tickets.