Package Documentation

Overview

The Orchard team aspire to have public-facing documentation for all software packages distributed via munki and the Orchard Software Centre. This documentation is intended both for end users and for IT support staff, and can be found by browsing the links in the Display Name column of the software list. The documentation follows a simple template which embeds a dictionary of key/value pairs into the static wiki page for the software.

Documenting a package

1. Once the software is in the production repo, it will appear in the software list. Click on the Display Name of the software to take you to an empty wiki page.

2. Create this page from the template Software/SoftwareTemplate

   • Once created (as noted in the comments at the top of the page:

     • update references to **DISPLAY_NAME** with the package display name (e.g. Amazing Widgets)

     • update references to **NAME** with the package name (e.g. Amazing_Widgets)

3. Click save changes, we will come back to this page momentarily.

4. Now add /InfoDict to the end of the url in your browser (e.g. if the url was https://docs.orchard.ox.ac.uk/Software/AmazingWidgets you would change this to https://docs.orchard.ox.ac.uk/Software/Amazing_Widgets/InfoDict)

5. Create this page from the template Software/InfoDictTemplate. The comments in the template should help you fill out the fields, but to clarify:

   • Fill in the details from the pkginfo file:

     • DisplayName:: should be display_name from the pkginfo

     • Description:: should be description from the pkginfo

   • For the LicenceStatus:: field choose from the options listed in the comments. e.g. if the software is completely free and open source, enter foss

   • For LicenceURL:: either include a relevant URL to licensing information or copy and paste the link to the anchor provided, and detail the licence situation later on the page generated above from the SoftwareTemplate

   • For BuildType:: enter autopkg if a recipe has been created, otherwise manual if the software has been built some other way

CategoryWikiToDo