This repository builds documentation for the official Hyrax Guide, OPeNDAP's data server.
This manual describes the features and operation of the Hyrax data server, a data server developed by OPeNDAP, Inc. as a reference server for the Data Access Protocol, versions 2 and 4. the Hyrax server is modular software with a number of handlers that are loaded into a core framework based on the contents of configuration files. Each of the server’s modules provides a distinct functional capability, such as reading data from a certain kind of file, encoding data, or processing data in different ways.
book-multi.txt is an example of the multipart book format for asciidoc.
edits.txt How I made lots of edits w/o mind-numbing manual searching and stuff
link_loc.txt Holds the current location of all the places that use the asciidoc link macro. In most cases these should be fixed because they are k=links to the *.adoc files, but those won't be present when we build the HTML or PDF documentation files. Instead, these should probably be section references (using anchors).
note_loc.txt I found a bunch of places where the text says, "Note:" in one way or another. Asciidoc has a special way of doing this that looks good (using 'NOTE:' with no indentation).
warnings.txt Same as above, but for 'WARNING:'
Added jhrg 9/17/17
- Use
----for the delimeters for source code - Use
....for the delimeters for litteral text like shell input - Use [source,xml] as a prefix to the source blocks (change language as needed). See info about coderay (http://coderay.rubychan.de/) for the allowed set.
If we use the book format, we can have a preface and should move the acknowledgements from Hyrax.adoc to there (I think) along with other text like, this is why Hyrax exists and/or other stuff that one usually finds in a Preface.
This is the main document for the whole manual. It now uses include directives in place of _link_s. There are notes in the file about building the manual as a multipart book. There other notes about missing content sections (like how to install the BES or start the OLFS).
I changed the title to The Hyrax Data Server Installation and Configuration Guide and it now has six sections (Overview, Installation, Configuration, Operation, Security, and Troubleshooting) and four appendices (WMS, handlers, Aggregation, and Server side processing).
Issues:
- Are these the correct sections and appendices?
- We must write/find the missing content (maybe its buried somewhere in one of these other files)
- The Troubleshooting section and Appendices B and C are way out of hand in terms of the TOC listings. Modify the stuff so that it has a more reasonable number of level two items
This is the source of the overview text. It has some notes about changes to the presentation of the overview. I think the OPeNDAP Hyrax development is sponsored by section should be in the acknowledgements subsection of the (now empty) Preface.
No notes except that this contains a link to the vanished BES_Installation file.
A set of includes; see below.
Included by Master_Hyrax_Configuration.adoc
Included by Master_Hyrax_Configuration.adoc. Also art of Troubleshooting
Included by Master_Hyrax_Configuration.adoc
Hyrax_Configuring_The_OLFS_To_Work_With_Multiple_BES's.adoc
Included by Master_Hyrax_Configuration.adoc
Included by Master_Hyrax_Configuration.adoc
Included by Master_Hyrax_Configuration.adoc
Part of the Configuration section
Part of Configuration
No includes or notes. Part of Operation
Part of Operation
Part of Security
Part of Security
includes files...
Part of Troubleshooting Think about moving this to Appendix E and adding text in Running bescmdln that says, "For a full listing of the commands, see..."
Part of Troubleshooting
Part of Troubleshooting
Appendix A, does not include files.
Appendix B; includes all of the handler documentation files
Appendix C; includes all of the files about aggreation.
Appendix D; no includes
Appendix E.
This needs significant work in both presentation and content. We need to decide how to fix the TOC it uses. We also need to add information on the DAP commands, since they are missing.
Also, we might move the BES Client Commands and text from Troubleshooting to here and then refer to the appendix in the text there.
In the aggreagtion directory:
- Use_cases_for_swath_and_time_series_aggregation.adoc - Somwhow this is actually an HTML file.
- THREDDS_using_XSLT.adoc
These files are derived from the Hyrax documentation pages on docs.OPeNDAP.org. I've extracted them from the files in documentation/other and then grouped them into the files in this directory and those in the sub-directories handlers and aggregation. The latter two hold information abut specific handlers and the aggregation handler that are bundled with the server.
The files reference images in the documentation/images directory, and those links will need to be fixed, one way or another.
I will remove the files from documentation/other that are here, so there are no duplicates.
The files that start with the prefix Master: Some are composite documents, others are just one file.
The files that are prefixed with Hyrax: The original files from the wiki. Some of these are 'included' by the 'Master' documents.