Difference between revisions of "Developer Documentation"

From PKP Wiki
Jump to: navigation, search
(Created page with "== Development Roadmap and Strategy == General Software Milestones -- a rough guide to upcoming PKP software releases for all products Development Cycle -- descriptio...")
 
Line 1: Line 1:
 +
== Getting Started ==
 +
[[Information for Developers]] -- For community contributors. Includes how to  identify existing bugs, contribute code, and set up your development environment.
 +
 
== Development Roadmap and Strategy ==
 
== Development Roadmap and Strategy ==
 
[[General Software Milestones]] -- a rough guide to upcoming PKP software releases for all products
 
[[General Software Milestones]] -- a rough guide to upcoming PKP software releases for all products
Line 5: Line 8:
  
 
[[PKP WAL Roadmap]] -- roadmap for the PKP Web Application Library, a shared codebase common to all PKP applications
 
[[PKP WAL Roadmap]] -- roadmap for the PKP Web Application Library, a shared codebase common to all PKP applications
 +
 +
== Working with Git ==
 +
[[HOW-TO check out PKP applications from git]]
 +
 +
[[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]]
 +
 +
== Testing ==
 +
[[Unit Tests]]
 +
 +
[[Web Tests]]
 +
 +
[[Non-technical Testing]]
 +
 +
== Usability/Web Design ==
 +
[[PKP Library Widgets]]
 +
 +
[[Open Monograph Press]]
 +
 +
== Current Development Documentation ==
 +
[[Migration issues]] -- PKP is working to integrate the new features of OMP -- which was released in 2012 and included a fundamental overhaul of the PKP code -- into our other applications. This page describes that process so that it can be used as the basis for future backporting.

Revision as of 16:06, 13 June 2013

Getting Started

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

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

HOW-TO check out PKP applications from git

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

Testing

Unit Tests

Web Tests

Non-technical Testing

Usability/Web Design

PKP Library Widgets

Open Monograph Press

Current Development Documentation

Migration issues -- PKP is working to integrate the new features of OMP -- which was released in 2012 and included a fundamental overhaul of the PKP code -- into our other applications. This page describes that process so that it can be used as the basis for future backporting.