Introducing PKP Developer Docs

June 6th, 2019 by  | Comments Off on Introducing PKP Developer Docs

Are you a software developer using OJS and/or OMP? Need help building themes, writing plugins, or developing new features? If so, help has arrived. PKP is excited to announce the launch of our Developer Documentation (aka Developer Docs). This new site is part of the PKP Docs Hub, our home for all PKP user guides. Technical users can now find all our developer guides compiled together in a hub of their own.

With the launch of PKP’s Developer Docs we are introducing two new guides for software developers. First, the Plugin Guide provides step-by-step guidance on how to build your own plugins. It introduces the different types of plugins you can build and contains a small but growing collection of examples that show you how to tailor one of our applications to suit your publishing needs.

Secondly, we’ve taken a different approach in our main Documentation resource. This new and improved guide provides a comprehensive introduction to the coding conventions and concepts that power PKP’s applications. It is designed to help developers who are new to OJS or OMP get up and running quickly. It describes the request life cycle, how to get data into and out of the database, and the most common utilities you will need to use to get stuff done.

In addition to these two documents, the Developer Docs site provides access to most of our existing documentation, such as the Theming Guide, UI Library and REST API Usage Guide. In the coming months we will be filling in gaps and adding more examples. Please let us know if there is something you would like to see included.


Comments are closed.