Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added draft JIRA process for handling documentation updates

...

  1. A JIRA is available to be picked up and worked on if it does not have anyone assigned to it
  2. To pick up and start working on a JIRA, assign yourself to a JIRA that that do not have anyone assigned

Writing the Documentation

  1. Each JIRA will have a template or a link to template for the write to use
  2. Writers will attach a text file to the JIRA ticket (NOTE: This will not be a patch file: Reasoning is that we do not want to lose contributors because they don't understand how to use subversion etc and create patches. The patch creation can be done at a later stage by the editors!)  and add a comment to the ticket that the file is ready for review  (Can we use any existing status to help?_

...

Reviewing Documentation

  1. Reviewers will check for any JIRA tickets ready for review (Not sure if we can use an existing status or rely on notification commnents. Perhaps when a document is started we already assign a reviewer who could also be a mentor....)
  2. Reviewers will read to ensure that the documentation is clear and readable (if they have any queries they can contact the writer)
  3. and check the written documentation and correct any minor grammatical errors
  4. Reviewers

...

  1. will then approve the text file as ready to be tested

Creating and Testing the Documentation

  1. Editors will then take the text file copy it into a working version of the Trunk
  2. They will copy the text file into the correct location in the documentation tree
  3. They will build the documentation and check that it the document appears correctly in the generated guide
  4. They will create a patch file for the documentation and attach it to the individual JIRA (NOTE: This means that the individual JIRA will contain the original text file received from the writer and also a patch file with the intergrated written text)
  5. They will change the status that the ticket has been tested and is ready to be committed to the Trunk

 

Creating and Testing the Documentation

 

...

Updating Documentation into the Trunk

  1. Editors that are committers will look for tickets that are ready to be committted and commit them into the trunk
  2. They will send notifications to the writers and reviewers that the document has been uploaded
  3. Editors will close the individual issue

========================== 

 

Initial  Team Setup Tasks

...