Modify

Opened 4 years ago

Last modified 18 months ago

#7292 new defect

Add a TracMetrix help page

Reported by: anonymous Owned by: rjollos
Priority: normal Component: TracMetrixPlugin
Severity: normal Keywords:
Cc: Trac Release: 0.12

Description

Either it's nonexistent, or it's very well hidden.

Please add basic use cases to the introductory material. Pictures of graphs with no description of how to generate them is... frustrating.

Attachments (1)

TracMetrixPluginsPage.png (42.3 KB) - added by rjollos 4 years ago.

Download all attachments as: .zip

Change History (16)

comment:1 Changed 4 years ago by rjollos

  • Owner changed from khundeen to rjollos

This is a good idea, and I will improve the documentation. This evening, while studying the source code, I discovered that there is also an mdashboard (Milestone Dashboard) that is accessible by clicking on each milestone. I had previously assumed that each milestone just linked to the standard milestone description, and had never bothered to click on them.

comment:2 Changed 4 years ago by rjollos

  • Summary changed from TracMetrix has no documentation on how to use it to Add a TracMetrix help page

We can add the help to the documentation, and add the following to the bottom of the page.


Note: See TracMetrix for help on using the project metrics.

<div id="help"><strong>Note:</strong> See
  <a href="${href.wiki('TracMetrix')}">TracMetrix</a> for help on using the project metrix.
</div>

comment:3 follow-up: Changed 4 years ago by jnelson@…

Until this is completed, can you add some stop-gap instructions in this thread or something? I just managed to get the plugin to work after working around #3684, but now haven't the faintest idea where to begin to make the charts I need. Clicking on links like in the Roadmap just nets me "No handler matched request to /mdashboard/M8".

comment:4 Changed 4 years ago by rjollos

Looks like we have another error to deal with. It should automatically make the charts you need. I will try to get #3684 fixed so that you don't need a workaround and will make sure this works correctly for me on a fresh setup ... we can proceed with debugging from there.

Changed 4 years ago by rjollos

comment:5 Changed 4 years ago by rjollos

  • Status changed from new to assigned

Replying to jnelson@real.com:

Clicking on links like in the Roadmap just nets me "No handler matched request to /mdashboard/M8".

Could you confirm that all of the components are enabled on the Plugins administration page?:

comment:6 in reply to: ↑ 3 Changed 4 years ago by rjollos

Replying to jnelson@real.com:

Clicking on links like in the Roadmap just nets me "No handler matched request to /mdashboard/M8".

Also, please upgrade to the latest revision of the 0.11 or 0.12 branch before testing since I fixed another issue today that was breaking the install.

comment:7 Changed 4 years ago by jnelson@…

Confirmed, all components are enabled. I upgraded to the latest revision (confirmed by verifying that #3684 no longer repros), with no effect on the "No handler matched request to /mdashboard/M8" error. Can file a separate bug for that issue, if desired. I thought that there was some configuration I still had to do, since I see references to [mdashboard] and [pdashboard] in other bugs but I have not added either of those to my trac.ini file.

comment:8 Changed 4 years ago by rjollos

Yeah, we should probably have another ticket for this. Please provide as much details about your Trac installation as you can think of. It works fine for me without configuring the sections in trac.ini, so its unlikely that is the issue. Is M8 the entire name of your milestone, or does it perhaps have some special characters in it?

comment:9 follow-ups: Changed 4 years ago by nelsojost

I'm not able to make TracMetrix to work. No Dashboard menu is showed in the mainnav (there is none config set in [mainnav] section of the trac.ini).

I have installed this plugin (with easy_install and building the .egg manually), but the only visible option in the plugin administration page is the first one, TracMetrixSetupPage from tracmetrixplugin.api. The dependencies are installed: Matplotlib and NumPy. I also put the follow section in trac.ini:

[pdashboard]
yui_base_url = http://yui.yahooapis.com/2.7.0    #Location of YUI API

but I'm not sure if this YUI api is being located.

Also, if I try to access /pdashboard page, I got No handler matched request to /pdashboard.

Really like the proposal of this plugin and hope can make it work.

I'm using:

  • Python 2.6
  • Trac 0.12
  • Postgre 8.4

comment:10 Changed 4 years ago by anonymous

Hello,

I just happened to see this thread. I would like to display such statistics graphs on my team's trac page. I know nothing about trac, and asked the IT to install this for me. They said they did. Can you give me a very basic example of usage? Many thanks!

comment:11 in reply to: ↑ 9 ; follow-up: Changed 20 months ago by anonymous

Replying to nelsojost: [ ... ]

I am running into the same error and I was curious if you were ever able to solve the problem?

comment:12 in reply to: ↑ 9 Changed 20 months ago by rjollos

Replying to nelsojost:

I'm not able to make TracMetrix to work. No Dashboard menu is showed in the mainnav (there is none config set in [mainnav] section of the trac.ini).

You'll be looking for an item on the mainnav named Metrics.

I have installed this plugin (with easy_install and building the .egg manually), but the only visible option in the plugin administration page is the first one, TracMetrixSetupPage from tracmetrixplugin.api.

You might need scipy as well, I'm not entirely sure. Open a python shell and type import pylab. If it succeeds, you have the required dependencies installed. It sounds like you don't however. You may also find some error messages when starting Trac, that say something like Skipping loading. You'll need to turn on logging. See t:TracLogging for info on enabling logging.

The dependencies are installed: Matplotlib and NumPy. I also put the follow section in trac.ini:

[pdashboard]
yui_base_url = http://yui.yahooapis.com/2.7.0    #Location of YUI API

but I'm not sure if this YUI api is being located.

I'm not sure you'll need that. As a start, I'd suggest leaving the default configuration.

comment:13 in reply to: ↑ 11 Changed 20 months ago by rjollos

Replying to anonymous:

Replying to nelsojost: [ ... ]

I am running into the same error and I was curious if you were ever able to solve the problem?

Please try what I suggested in comment:12 and also list the versions of Python and Trac that you are using.

comment:14 Changed 20 months ago by rjollos

Also, please make sure to update your source since I just committed a fix for traceback in [12799].

comment:15 Changed 18 months ago by rjollos

  • Status changed from assigned to new

Add Comment

Modify Ticket

Action
as new The owner will remain rjollos.
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.