Difference between revisions of "Developer Info"

From OPeNDAP Documentation
m (For Software Developers)
m
Line 8: Line 8:
 
** [https://scan.coverity.com/projects/opendap-libdap4?tab=overview libdap - The implementation of DAP2 and DAP4]
 
** [https://scan.coverity.com/projects/opendap-libdap4?tab=overview libdap - The implementation of DAP2 and DAP4]
  
== Developer Guidelines and Information ==
+
== OPeNDAP's FAQ ==
 
The [http://www.opendap.org/faq-page OPeNDAP FAQ] has a pretty good section on developer's questions.
 
The [http://www.opendap.org/faq-page OPeNDAP FAQ] has a pretty good section on developer's questions.
 +
 +
== OPeNDAP Workshops ==
 +
* [http://www.opendap.org/about/workshops-and-presentations/2007-10-12 The APAC/BOM Workshops]: This workshop spanned several days and covered a number of topics, including information for SAs and Developers. Oct 2007.
 +
* [http://www.opendap.org/about/workshops-and-presentations/2008-07-15 ESIP Federation Server Workshop]: This half-day workshop focused on server installation and configuration. Summer 2008
 +
* [[A One-day Course on Hyrax Development | Server Functions]]: This one-day workshop is all about writing and debugging server-side functions. It also contains a wealth of information about Hyrax, the BES and debugging tricks for the server. Spring 2012. Updated Fall 2014 for presentation to Ocean Networks Canada.
 +
 +
== libdap4 and BES Reference documentation ==
 +
* [http://old.opendap.org/api/bes/html/index.html BES Reference]
 +
* [http://old.opendap.org/api/libdap/html/index.html libdap Reference]
 +
 +
== BES Development Information ==
 +
* [[Hyrax - Logging Configuration|Logging Configuration]]
 +
 +
* [[BES_-_How_to_Debug_the_BES| How to debug the BES]]
 +
* [[BES - Debugging Using besstandalone]]
 +
* [[Hyrax - Create BES Module | How to create your own BES Module]]
 +
* Hyrax Module Integration: How to configure your module so it's easy to add to Hyrax instances ([[:File:HyraxModuleIntegration-1.2.pdf|pdf]])
 +
* [[Hyrax - Starting and stopping the BES| Starting and stopping the BES]]
 +
* [[Hyrax - Running bescmdln | Running the BES command line client]]
 +
* [[Hyrax - BES Client commands| BES Client commands]]
 +
* [[BES_XML_Commands | BES XML Commands]]
 +
* [[Hyrax - Extending BES Module | Extending your BES Module]]
 +
* [[Hyrax - Example BES Modules | Example BES Modules]] - the Hello World example and the CSV data handler
 +
* [[Hyrax - BES PPT | BES communication protocol using PPT (point to point transport)]]
 +
* [[Hyrax:_BES_Administrative_Commands| BES Administrative Commands]]
 +
 +
* [[Australian BOM Software Developer's Agenda and Presentations|Software Developers Workshop]]
  
 
== General development information ==
 
== General development information ==
Line 19: Line 46:
 
* [https://developer.mozilla.org/en-US/docs/Eclipse_CDT Eclipse - Detailed information about running Eclipse on OSX from the Mozzilla project]. Updated in 2017, this is really good but be aware that it's specific to Mozilla so some of the tips don't apply. Hyrax (i.e., libdap4 and BES) also use their own build system (autotools + make) so most of the configuration information here is very apropos. See also [[How to use Eclipse with Hyrax Source Code]] below.
 
* [https://developer.mozilla.org/en-US/docs/Eclipse_CDT Eclipse - Detailed information about running Eclipse on OSX from the Mozzilla project]. Updated in 2017, this is really good but be aware that it's specific to Mozilla so some of the tips don't apply. Hyrax (i.e., libdap4 and BES) also use their own build system (autotools + make) so most of the configuration information here is very apropos. See also [[How to use Eclipse with Hyrax Source Code]] below.
 
* [https://jfearn.fedorapeople.org/en-US/RPM/4/html/RPM_Guide/index.html RPM Guide] The best one I'm found so far...
 
* [https://jfearn.fedorapeople.org/en-US/RPM/4/html/RPM_Guide/index.html RPM Guide] The best one I'm found so far...
 
== OPeNDAP Workshops ==
 
* [http://www.opendap.org/about/workshops-and-presentations/2007-10-12 The APAC/BOM Workshops]: This workshop spanned several days and covered a number of topics, including information for SAs and Developers. Oct 2007.
 
* [http://www.opendap.org/about/workshops-and-presentations/2008-07-15 ESIP Federation Server Workshop]: This half-day workshop focused on server installation and configuration. Summer 2008
 
* [[A One-day Course on Hyrax Development | Server Functions]]: This one-day workshop is all about writing and debugging server-side functions. It also contains a wealth of information about Hyrax, the BES and debugging tricks for the server. Spring 2012. Updated Fall 2014 for presentation to Ocean Networks Canada.
 
  
 
== OPeNDAP Development process information  ==
 
== OPeNDAP Development process information  ==
Line 52: Line 74:
 
* [[Growing a CentOS Root Partition on an AWS EC2 Instance]]
 
* [[Growing a CentOS Root Partition on an AWS EC2 Instance]]
 
* [[How Shutoff the CentOS firewall]]
 
* [[How Shutoff the CentOS firewall]]
 
= TRANSFERED FROM HYRAX INSTALL PAGE =
 
===== BES Development Information =====
 
* [[Hyrax - Logging Configuration|Logging Configuration]]
 
 
* [[BES_-_How_to_Debug_the_BES| How to debug the BES]]
 
* [[BES - Debugging Using besstandalone]]
 
* [[Hyrax - Create BES Module | How to create your own BES Module]]
 
* Hyrax Module Integration: How to configure your module so it's easy to add to Hyrax instances ([[:File:HyraxModuleIntegration-1.2.pdf|pdf]])
 
* [[Hyrax - Starting and stopping the BES| Starting and stopping the BES]]
 
* [[Hyrax - Running bescmdln | Running the BES command line client]]
 
* [[Hyrax - BES Client commands| BES Client commands]]
 
* [[BES_XML_Commands | BES XML Commands]]
 
* [[Hyrax - Extending BES Module | Extending your BES Module]]
 
* [[Hyrax - Example BES Modules | Example BES Modules]] - the Hello World example and the CSV data handler
 
* [[Hyrax - BES PPT | BES communication protocol using PPT (point to point transport)]]
 
* [[Hyrax:_BES_Administrative_Commands| BES Administrative Commands]]
 
 
* [[Australian BOM Software Developer's Agenda and Presentations|Software Developers Workshop]]
 
 
<!-- There is a link to this on the main opendap.org page. I'll put a copy of that on the Developer Info page, where it's more appropriate. jhrg * [[Australian BOM Software Developer's Agenda and Presentations|Software Developers Workshop]] -->
 
 
==Reference documentation==
 
 
* [http://old.opendap.org/api/bes/html/index.html BES Reference]
 
* [http://old.opendap.org/api/libdap/html/index.html libdap Reference]
 
  
  

Revision as of 21:53, 10 April 2017

1 OPeNDAP's FAQ

The OPeNDAP FAQ has a pretty good section on developer's questions.

2 OPeNDAP Workshops

  • The APAC/BOM Workshops: This workshop spanned several days and covered a number of topics, including information for SAs and Developers. Oct 2007.
  • ESIP Federation Server Workshop: This half-day workshop focused on server installation and configuration. Summer 2008
  • Server Functions: This one-day workshop is all about writing and debugging server-side functions. It also contains a wealth of information about Hyrax, the BES and debugging tricks for the server. Spring 2012. Updated Fall 2014 for presentation to Ocean Networks Canada.

3 libdap4 and BES Reference documentation

4 BES Development Information

5 General development information

These pages contain general information relevant to anyone working with our software:

6 OPeNDAP Development process information

These pages contain information about how we'd like people working with us to use our various on-line tools.

  • Hyrax GitHub Source Build This explains how to clone our software from GitHub and build our code using a shell like bash. It also explains how to build the BES and all of the Hyrax 'standard' handlers in one operation, as well as how to build just the parts you need without cloning the whole set of repos. Some experience with 'git submodule' will make this easier, although the page explains everything.
  • How to Plan a Release Sprint A general template for planning a release in Jira or the equivalent.
  • Making a Release. Once software is ready for distribution, use this checklist to make sure you do all of the steps needed to make a release.
  • Making RPM Distributions. Follow these steps to create an RPM distribution of the software.
  • Making a Release of OLFS. Follow these steps to create the three .jar files needed for the OLFS release. Includes information on how to build the OLFS and how to run the tests.
  • Bug Prioritization. How we prioritize bugs in our software.
6.1 Software process issues:

6.2 AWS Tips


7 Old information

Note: The following is all about using Subversion and is out of date as of November 2014 when we switched to git. There are still good ideas here...