Create a product
Before any other objects can be created, at least one product must exist in the Ponydocs system.
Note: In addition to defining the product and its description as explained below, the administrator of your Ponydocs implementation must also must configure the value of
$ponyDocsProductsList to match this list of products exactly.
To access the Products page, use the following URL, substituting the server name for your own Ponydocs server in place of
This page drives the listing of available products on the Documentation landing page.
Things to know when creating a product
- The products appear on the Documentation landing page in the order in which they are defined on this page.
- A product can designate another product as its parent, so you can have suites or collections of products.
Create a product using the following syntax:
- <productShortName> is what gets used in the URL for that product.
- <displayName> is what is shown in the list of products the end user sees on the Documentation landing page.
Note: Do not use URL-unsafe characters such as : (colon), ? (question mark), / (forward slash), or spaces in the short name.
parent fields are optional.
When you save the Products page, the products you add are not displayed on the Documentation landing page until you create at least one version, manual, and topic for each product.
Overview of objects in Ponydocs
Create a version
This documentation applies to the following versions of Ponydocs: 1.0