Changes between Version 1 and Version 2 of PeerReviewPlugin/Documentation

Timestamp:

May 30, 2008, 10:04:12 PM (16 years ago)

Author:

Sebastian Marek

Comment:

--

PeerReviewPlugin/Documentation

@@ -1 @@
-See documentation attached to the source code
+== Distributed Peer Review - User Guide ==
+
+Distributed Peer Review system is a plug-in for TRAC that facilitates distributed peer review of code. Normally peer review happens in a central location with paper copies of code, or works in an unorganized fashion involving email or other electronic means to communicate. However, these systems are inefficient for multiple code reviews, and can become unmanageable very quickly. Hence, this system assists developers in managing and performing code reviews in a distributed way.
+
+=== Description ===
+
+Distributed peer review facilitates code review without the need for all team members to meet together, saving valuable time. In addition, changes proposed under a distributed system are easier to implement. Our project seeks to create a distributed peer review system by creating a plug-in for TRAC, which is a browser-based content management system that includes bug-tracking. The plug-in integrates with Subversion, a popular open-source version control system.   
+TRAC supports plug-in development with Python on the backend, and ClearSilver, a fast and powerful HTML template system, on the front-end. Javascript and AJAX were used to provide pages with dynamic features. An SQLite database is utilized to store all information about reviews and users.
+
+''Notes:''
+Since version 2.1 plugin is going to use new template engine - Genshi, and support SQLite, PostgreSQL and MySQL database backends.
+
+=== Main Page ===
+
+=== New Code Review ===
+
+=== Peer Review Search ===
+
+=== Perform Code Review ===
+
+=== View Code Review ===
+
+=== Manager Options ===
+
+=== Manager Options ===
+
+=== Glossary ===
+
+=== License/Disclaimer ===