1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 <2016> 2017 2018 2019 2020 2021 2022 2023 2024 | Index | 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 <2016> 2017 2018 2019 2020 2021 2022 2023 2024 |
<== Date ==> | <== Thread ==> |
---|
Subject: | RE: motor6-10 |
From: | "Mooney, Tim M." <[email protected]> |
To: | "Rivers, Mark L." <[email protected]>, Matt Newville <[email protected]>, "Jemian, Pete R." <[email protected]> |
Cc: | EPICS Tech Talk <[email protected]> |
Date: | Wed, 9 Nov 2016 22:57:31 +0000 |
Hi Mark,
I don't plan to move those pages ever, and I plan to continue maintaining them, at least for the modules I work on. It will be very nice also to have documentation readily available on github (at least the master branch), but all the docs for all the versions seems like quite a bit to add to README.md. Tim Mooney ([email protected]) (630)252-5417
Beamline Controls Group (www.aps.anl.gov) Advanced Photon Source, Argonne National Lab From: [email protected] [[email protected]] on behalf of Mark Rivers [[email protected]]
Sent: Wednesday, November 09, 2016 4:34 PM To: Matt Newville; Jemian, Pete R. Cc: EPICS Tech Talk Subject: RE: motor6-10 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
Pete,
On Wed, Nov 9, 2016 at 2:29 PM, Pete Jemian <[email protected]> wrote: See the synApps utils module for an example:
Oh, one can set up gh-pages to use the docs/ folder in the master branch (or even just the master branch) instead of a separate gh-pages branch. |