Changes between Version 44 and Version 45 of AnalyzePlugin

Timestamp:

May 10, 2022, 5:47:05 AM (2 years ago)

Author:

figaro

Comment:

Move examples to functional description

AnalyzePlugin

@@ -18 +18 @@
 [[Image(ask_analyze.png, border=2)]]
 
-See below for further examples.
-
-== Bugs/Feature Requests
-
-Existing bugs and feature requests for AnalyzePlugin are 
-[report:9?COMPONENT=AnalyzePlugin here].
-
-If you have any issues, create a 
-[/newticket?component=AnalyzePlugin new ticket].
-
-[[TicketQuery(component=AnalyzePlugin&group=type,format=progress)]]
-
-== Download
-
-Download the zipped source from [export:analyzeplugin here].
-
-== Source
-
-You can check out AnalyzePlugin from [/svn/analyzeplugin here] using Subversion, or [source:analyzeplugin browse the source] with Trac.
-
-== Installation
-
- 1. Download and unzip the plugin.
- 2. Install the plugin:
- {{{#!sh
-cd analyzeplugin/0.12
-sudo python setup.py bdist_egg
-sudo cp dist/TracAnalyze*.egg /your/trac/location/plugins/
-}}}
-
- See [t:TracPlugins TracPlugins] for more installation details and options. You'll likely need to restart Trac's web server after installation.
-
- 3. Enable the plugin by adding the following to your `trac.ini` file:
- {{{#!ini
-[components]
-analyze.* = enabled
-}}}
-
- You can alternatively use the Trac Web Admin GUI to enable any or all rules.
-
-== Configuration
-
-Enable the {{{ANALYZE_VIEW}}} permission for those users who are allowed to execute analyses.
-
-== Examples
-
-This plugin currently includes four analyses that can each be individually enabled for one or more reports. Each analysis is configured by modifying the {{{[analyze]}}} section of {{{trac.ini}}}, see below for examples. When an analysis is enabled for a report, an '''Analyze...''' button appears at the top of the report and the analysis' name will appear in the subsequent dialog box when the button is clicked. You can either choose a single analysis or all analyses in this dialog box. Selecting "All" will run them serially.
-
-'''Important:''' The current analyses do not, for example, detect circular dependencies nor can they handle complex relationships all in one pass. This means that after a pass of fixes, the changes may have caused or exposed other issues that another analysis pass will uncover. So the general usage pattern is to continue re-running analyses until "quiescence" is reached, ie until there are no more issues to fix.
+=== Examples
+
+The four analyses can be individually enabled for one or more reports. Each analysis is configured by modifying the {{{[analyze]}}} section of {{{trac.ini}}}, see below for examples. When an analysis is enabled for a report, an '''Analyze...''' button appears at the top of the report and the analysis' name will appear in the subsequent dialog box when the button is clicked. You can either choose a single analysis or all analyses in this dialog box. Selecting "All" will run them serially.
+
+'''Note:''' The current analyses do not, for example, detect circular dependencies nor can they handle complex relationships all in one pass. This means that after a pass of fixes, the changes may have caused or exposed other issues that another analysis pass will uncover. So the general usage pattern is to continue re-running analyses until "quiescence" is reached, ie until there are no more issues to fix.
 
 ==== Milestone Dependency Analysis
@@ -189 +145 @@
 Detected changes to rollup field values are shown with an option to automatically update the value, see screenshot above.
 
-== Tips and hints
+=== Tips and hints
 
 A few ideas to optimize your analysis experience:
@@ -199 +155 @@
  * The core analyses are maintained in Python modules that require no imports. This was intentional so that they may be easily wrapped and called from a monitoring script, eg [https://github.com/trifthen/NagAconda nagaconda] for nagios, so that you can be proactively alerted to ticket scheduling issues without needing to manually run analyses in Trac.
 
-== Extensibility (implementation details)
+=== Extensibility (implementation details)
 
 Each analysis is implemented as a Trac extension point to allow for new analyses to be added fairly easily. See [browser:analyzeplugin/0.12/analyze/analysis.py analysis.py] for the {{{IAnalysis}}} interface. In brief, you only need to define two methods for each analysis:
@@ -211 +167 @@
 
 See the code for examples and other smaller tweaks to the {{{IAnalysis}}} interface and base {{{Analysis}}} class.
+
+== Bugs/Feature Requests
+
+Existing bugs and feature requests for AnalyzePlugin are 
+[report:9?COMPONENT=AnalyzePlugin here].
+
+If you have any issues, create a 
+[/newticket?component=AnalyzePlugin new ticket].
+
+[[TicketQuery(component=AnalyzePlugin&group=type,format=progress)]]
+
+== Download
+
+Download the zipped source from [export:analyzeplugin here].
+
+== Source
+
+You can check out AnalyzePlugin from [/svn/analyzeplugin here] using Subversion, or [source:analyzeplugin browse the source] with Trac.
+
+== Installation
+
+ 1. Download and unzip the plugin.
+ 2. Install the plugin:
+ {{{#!sh
+cd analyzeplugin/0.12
+sudo python setup.py bdist_egg
+sudo cp dist/TracAnalyze*.egg /your/trac/location/plugins/
+}}}
+
+ See [t:TracPlugins TracPlugins] for more installation details and options. You'll likely need to restart Trac's web server after installation.
+
+ 3. Enable the plugin by adding the following to your `trac.ini` file:
+ {{{#!ini
+[components]
+analyze.* = enabled
+}}}
+
+ You can alternatively use the Trac Web Admin GUI to enable any or all rules.
+
+== Configuration
+
+Enable the {{{ANALYZE_VIEW}}} permission for those users who are allowed to execute analyses.
 
 == Recent Changes