Ponydocs

Build content in Ponydocs

Download manual as PDF

Download topic as PDF

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 <yourponydocsserver>.

http://<yourponydocsserver>/Documentation:Products

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.

Syntax

Create a product using the following syntax:

 {{#product:productShortName|displayName|description|parent}} 
  • <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.

The description and 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.

PREVIOUS
Overview of objects in Ponydocs
  NEXT
Create a version

This documentation applies to the following versions of Ponydocs: 1.0


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters