Versioned Track Hubs

Overview

This page exists to help capture the process change when editing Track Hubs.

How to work with the 'versioned' track hub settings

What these mean for engineers:

-> When you add a new setting, you will need to set it to 'level-new'.

Next time the doc is versioned, we will evaluate the new settings for assignment to a level.

-> After adding a setting to the doc, you will need to run 'hubCheck -settings' to see if your addition is formatted correctly.

To list all v1 settings (with levels) on genome-test, run

hubCheck -settings -test

The README.txt in the trackDb docs dir (and below) has been extended to include these steps. The new bits are in item #3.

---

$ cat ~kent/src/hg/htdocs/goldenPath/help/trackDb/README.txt

To add a new statement to the trackDb documentation:

1. Add your statement documentation to trackDbLibrary.shtml

2. Add references to your statement to trackDbDoc.html

3. If intended for hubs:
* Add to the latest trackDbHub doc (e.g. trackDbHub.v1.html), with support level 'new'.
(see intro of the doc for explanation of support levels).
* Use hubCheck to verify the doc entry is properly formatted:
% make
% hubCheck -settings \
-version=http://hgwdev-<user>/goldenPath/help/trackDb/trackDbHub.v1.html
OR
% make alpha
% hubCheck -settings -test

- See the long comment at the top of trackDbLibrary.shtml for details

head -n 125  ~kent/src/hg/htdocs/goldenPath/help/trackDb/trackDbLibrary.shtml