Ponydocs

Build content in Ponydocs

Download manual as PDF

Download topic as PDF

Create a version

Once you've created a product, the next step is to create one or more versions that apply to this product.

To access the Versions management page, use the following URL, substituting the server name for your own Ponydocs server in place of <yourponydocsserver>.

http://<yourponydocsserver>/Documentation:<product short name>:Versions

This page drives the dropdown list of versions available for the defined product in addition to the state of that version, which designates whether the end user can or cannot see content tagged with that version. For more information about version state, refer to this overview of versions.

Note: If there are no manuals for the selected version the version will NOT appear in the drop-down list.

Things to know when creating a version

  • A version must be defined here before any topics may be tagged with that version.
  • The versions can be any text or numeric string, such as 1.1.4 or Beta or 1.0beta.
  • The versions should be listed in release order; that is, the newest/latest versions should be closer to the bottom of this page as this is where you would typically add them.
  • Change the status of a version by editing this file (from unreleased to released, for example).
  • To edit the versions page for a given product, you must have "docteam" permissions for the specific product for which you're adding a version. for example, if you want to edit the versions page for the Unicorns product, you must have the checkbox checked for "unicorns-docteam" on the permissions page. if you don't see a link to create/edit the versions page, you probably don't have that permission.

Syntax

Create a version using the following syntax:

{{#version:<name>|[released|unreleased|preview}}

For example, the entry for versions 1.0Beta1 and 1.0Beta2, both in preview status, would look like this when you have the Versions management topic open for editing:

{{#version:1.0Beta1|preview}}
{{#version:1.0Beta2|preview}}

When you save the Versions management page, the version you added is created in Ponydocs.

PREVIOUS
Create a product
  NEXT
Create a manual

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