Changes between Version 26 and Version 27 of SensitiveTicketsPlugin

Timestamp:

Dec 24, 2016, 7:45:41 AM (7 years ago)

Author:

figaro

Comment:

Moved example to functional description

SensitiveTicketsPlugin

@@ -5 +5 @@
 == Description
 
-This is a plugin that lets users mark tickets as "sensitive" with a checkbox on the ticket form. Sensitive tickets are viewable only to those with the `SENSITIVE_VIEW` permission.
+This is a plugin that lets users mark tickets as "sensitive" with a checkbox on the ticket form. Sensitive tickets are viewable only to those with the `SENSITIVE_VIEW` permission. There are the following use cases for this:
+
+'''Scenario 1'''
+
+A user submits a security related ticket to a project's Trac, which is generally open to the public. They mark it as "Sensitive" so that only people in the internal team that deal with security issues can see the ticket.
+
+'''Scenario 2'''
+
+A team uses Trac to handle its business development tasks, but wants to leave the record open for all. Some tasks, however, say, dealing with difficult clients, are sensitive. Those tickets are marked as sensitive and hidden to others, but viewable by the business development team.
 
 '''Beware''':
  * Hooks that send mail on ticket changes will still send mail for sensitive tickets; this may not be what you want.
- * In versions of Trac prior to 1.0.2, if the plugin is removed, disabled, or fails to load, Trac will display sensitive tickets ([ticket:5784 "failing open" instead of "failing closed"]).
+ * In versions of Trac prior to 1.0.2, if the plugin is removed, disabled, or fails to load, Trac will display sensitive tickets ([ticket:5784 ""failing open" instead of "failing closed""]).
 
 This plugin is supported on Trac 0.11.6 or higher.
@@ -55 +63 @@
 Needs an environment upgrade or just adding the appropriate stanza to `[ticket-custom]` in `trac.ini` after enabling.
 
-== Example
-
-'''Scenario 1'''
-
-A user submits a security related ticket to a project's Trac, which is generally open to the public. They mark it as "Sensitive" so that only people in the internal team that deal with security issues can see the ticket.
-
-'''Scenario 2'''
-
-A team uses Trac to handle its business development tasks, but wants to leave the record open for all. Some tasks, however, say, dealing with difficult clients, are sensitive. Those tickets are marked as sensitive and hidden to others, but viewable by the business development team.
-
 == Recent Changes