Experimental Physics and
Industrial Control System

One concern I have with moving the home of the synApps documentation from the APS to github is the existence of many URL references in existing documentation.  Here is a search of the synApps (and areaDetector) tree for such links to documents at the APS:

 

corvette:~/devel>find . -name '*.html' -exec grep -H www.aps.anl.gov {} \; | wc

    469    2174   66753

 

So there are 469 such links that need to be changed.  Since the “best” URL to use for git documentation seems to be a moving target, I worry about having to change these frequently.

 

There are also 339 references to the documentation on the CARS web server for software I have developed:

 

corvette:~/devel>find . -name '*.html' -exec grep -H "http://cars" {} \; | wc

    339    1325   49981

 

In areaDetector there are many cross-links to documentation within the different areaDetector repositories.  I have avoided putting URLs on those at all, and simply copy all of the HTML files to the same directory on our Web server, so the files will be found automatically.  For example:

 

./areaDetector-2-5/documentation/html/simDetectorDoc.html:    This is an <a href="" <a href="">

 

So the EPICS documentation link uses an http URL, but areaDetector.html is assumed to be a file in the same directory.  How would this be handled in a maintainable way if the documentation home move to github where simDetector.html and areaDetector.html reside in different repositories?

 

Mark

 

 

 

 

 

From: [email protected] [mailto:[email protected]] On Behalf Of Matt Newville
Sent: Wednesday, November 09, 2016 4:06 PM
To: Pete Jemian
Cc: EPICS Tech Talk
Subject: Re: motor6-10