Difference between revisions of "Developer Documentation"

From PKP Wiki
Jump to: navigation, search
(Usability/Web Design)
(Getting Started)
(4 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
[[Installation: Multiple OJS & mOJO]] -- For sysadmins or developers. How to install an independent OJS for each magazine and manage all of them from your command shell.
 
[[Installation: Multiple OJS & mOJO]] -- For sysadmins or developers. How to install an independent OJS for each magazine and manage all of them from your command shell.
 +
 +
[[Potential issues with RedHat installation]]  -- For sysadmins or developers. Some information on RedHat/CentOS installation not covered by the default documentation.
  
 
== Development Roadmap and Strategy ==
 
== Development Roadmap and Strategy ==
Line 12: Line 14:
  
 
== Working with Git ==
 
== Working with Git ==
[[HOW-TO check out PKP applications from git]]
+
 
 +
[[Github Documentation for PKP Contributors]]
  
 
[[Frequent git use cases]]
 
[[Frequent git use cases]]
Line 19: Line 22:
  
 
[[Differences between CVS and git for PKP devs]]
 
[[Differences between CVS and git for PKP devs]]
 
[[Github Documentation for PKP Contributors]]
 
  
 
== Code Design ==
 
== Code Design ==
Line 51: Line 52:
  
 
[[Integration Testing Use Cases]] lists and describes the specific tests run in Integration Testing.
 
[[Integration Testing Use Cases]] lists and describes the specific tests run in Integration Testing.
 +
 +
[[Test Data Creation Suite]] is a suite of Selenium-based tests that create a basic data set for testing, presentations and workshops, etc.
  
 
== Usability/Web Design ==
 
== Usability/Web Design ==
[[OJS UI/UX]]
+
* [[OJS UI/UX]]
[[OMP UI/UX]]
+
* [[OMP UI/UX]]
[[PKP Library Widgets]]
+
* [[PKPWAL UI/UX]]
[[Open Monograph Press]]
+
* [[PKP Library Widgets]]
 +
* [[Open Monograph Press]]
  
 
== Current Development ==
 
== Current Development ==
 
[[Migration issues]] -- notes on how to backport the new features that were introduced in OMP into other PKP applications
 
[[Migration issues]] -- notes on how to backport the new features that were introduced in OMP into other PKP applications

Revision as of 00:44, 26 June 2014

Getting Started

Information for Developers -- For community contributors. Includes how to identify existing bugs, contribute code, and set up your development environment.

Installation: Multiple OJS & mOJO -- For sysadmins or developers. How to install an independent OJS for each magazine and manage all of them from your command shell.

Potential issues with RedHat installation -- For sysadmins or developers. Some information on RedHat/CentOS installation not covered by the default documentation.

Development Roadmap and Strategy

General Software Milestones -- a rough guide to upcoming PKP software releases for all products

Development Cycle -- description of the pattern PKP follows in terms of releases and branches

PKP WAL Roadmap -- roadmap for the PKP Web Application Library, a shared codebase common to all PKP applications

Working with Git

Github Documentation for PKP Contributors

Frequent git use cases

Git sub-module tutorial

Differences between CVS and git for PKP devs

Code Design

JavaScript coding conventions -- the JS coding conventions that PKP uses.

JavaScript widget controllers -- description and explanation of the standard PKP javascript widget controllers that are implemented throughout the codebase.

Router Architecture

AJAX framework

Authorization Framework

Metadata and Filter Framework

Data Access Objects (DAO)

Third Party Library Integration Policy

Localization

Front-end Cookbook

Testing

Unit Tests are developer-centric code tests.

Integration Testing is automated testing of the web interface.

User Tests are tests performed by live humans.

Integration Testing Use Cases lists and describes the specific tests run in Integration Testing.

Test Data Creation Suite is a suite of Selenium-based tests that create a basic data set for testing, presentations and workshops, etc.

Usability/Web Design

Current Development

Migration issues -- notes on how to backport the new features that were introduced in OMP into other PKP applications