Re: motor6-10 - thread hijack to "synApps documentation"

["J. Lewis Muir" <jlmuir@imca-cat.org>]

On 11/11, Pete Jemian wrote:
> synApps documentation news
> ==========================
> 
> home page
> ---------
> 
> The synApps home page is
>   http://aps.anl.gov/bcda/synApps
> 
> We intend to keep the synApps home page at this URL.

Hi, Pete!

Excellent!

> the Drupal transition at APS
> ----------------------------
> 
> The APS web server is now undergoing a transition to Drupal and will
> take some time to complete.  The above address is redirected to
>   https://www1.aps.anl.gov/BCDA/synApps
> 
> Pages that are below http://aps.anl.gov/bcda/synApps/ are not likely
> to redirect.  This will be a temporary inconvenience of indefinite
> duration.  Once the Drupal transition is complete, everything will
> be moved back to the main URL base.

Sounds good!

> cross links
> -----------
> 
> For each of the BCDA synApps modules described on this page:
>   https://www1.aps.anl.gov/BCDA/synApps/Included-Modules
> the GitHub repository and the documentation have been cross-linked.
> 
> docs -> GitHub repo
> GitHub repo --> docs
> 
> A link to the corresponding GitHub repository has been added to the
> module's linked documentation page.  Similarly, the GitHub
> repository has a link back to that documentation page.  This link
> may be found near the top of the repository home page.

Very nice!  I think this is a great addition!

I did notice, however, that the love module's page did not receive this
treatment:

  http://aps.anl.gov/bcda/synApps/love/love.html

Although its GitHub page did:

  https://github.com/epics-modules/love

I also noticed that the following pages do not link to their
corresponding GitHub location, but I understand these are not under
your charge.  These are all owned by Mark Rivers.  Mark, any chance of
getting a GitHub link on the web pages for these?

* camac -> https://github.com/epics-modules/camac
* dac128V -> https://github.com/epics-modules/dac128V
* dxp -> https://github.com/epics-modules/dxp
* ip330 -> https://github.com/epics-modules/ip330
* ipUnidig -> https://github.com/epics-modules/ipUnidig

Lastly, the list of modules included with synApps but not part of
synApps has the following issues:

* genSub: Broken link.  Perhaps should be
  <http://www.observatorysciences.co.uk/epics_downloads_new.php>?
* ipac: Should be <https://github.com/epics-modules/ipac/wiki>.
* vxStats: Broken link.

> viewing a module's HTML documentation
> -------------------------------------
> 
> Any HTML files in the <GitHub repo>/documentation directory have
> been added to a README.md that provides an htmlpreview.github.io
> prefix to render the page.

Nice!

> Hopefully, this will address the concerns about cross-referencing
> between documentation, source code repositories, and the synApps
> home page.

Indeed!  Thanks much!

Lewis