Page MenuHomePhabricator

Documentation is awful
Closed, ResolvedPublic


The page on ( needs to be updated with

  • The git information in a more sane format
  • Consistent git information (not google code)
  • Information on how to start using the extension (right now it's impossible to test the extension)
  • Possibly information on development

Version: master
Severity: normal



Event Timeline

bzimport raised the priority of this task from to Needs Triage.Nov 22 2014, 1:02 AM
bzimport set Reference to bz39979.

Thanks for pointing out the outdated SVN links, they have now been updated to use git.

I've added some documentation on usage and features, including how to start using it from a user (rather than sysadmin) perspective, in the ==Usage== section. doesn't look _awful_ to me, and it seems to be decently filled with useful content, including the points addressed by the reporter.


Otherwise, what would be the points still open?

I'm pretty happy with the current solution, yes. The only remaining thing I'd add would be more specific instructions for the "Quick instructions for getting started" section. It says to add the "course coordinator" user right, but there aren't specific instructions for what that entails. Elsewise I'm happy.

Thanks for the feedback, Mark and Quim.

I've expanded the quick instructions to make it more clear and detailed. I'm marking it as FIXED.