Developer Info: Difference between revisions

From OPeNDAP Documentation
⧼opendap2-jumptonavigation⧽
mNo edit summary
mNo edit summary
Line 14: Line 14:
These pages contain general information relevant to anyone working with our software:
These pages contain general information relevant to anyone working with our software:


* [[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.
* [[Git Hacks and Tricks]]: Information about using git and/or GitHub that seems useful and maybe not all that obvious.
* [[ConfigureCentos| How to configure a CentOS machine for production of RPM binaries]] - Updated 12/2014 to include information regarding git.
* [[Migrating source code from SVN to git]]: How to move a large project from SVN to git and keep the history, commits, branches and tags.
* [[How to use Eclipse with Hyrax Source Code]] Assuming you have cloned our Hyrax code from GitHub, this explains how to setup eclipse so you can work fairly easily and switch back and forth between the shell, emacs and eclipse.
* [https://developer.mozilla.org/en-US/docs/Eclipse_CDT Eclipse - Detailed information about running Eclipse on OSX from the Mozzilla project]. Maybe a bit out of date.
* [https://developer.mozilla.org/en-US/docs/Eclipse_CDT Eclipse - Detailed information about running Eclipse on OSX from the Mozzilla project]. Maybe a bit out of date.


=== Workshops ===
== OPeNDAP Workshops ==
* [http://www.opendap.org/apac_workshop_vm 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/apac_workshop_vm 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/ESIP_Federation_Hyrax_workshop ESIP Federation Server Workshop]: This half-day workshop focused on server installation and configuration. Summer 2008
* [http://www.opendap.org/ESIP_Federation_Hyrax_workshop 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.
* [[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.


== Development process information (OPeNDAP Specific) ==
== OPeNDAP Development process information ==
These pages contain information about how we'd like people working with us to use our various on-line tools.
These pages contain information about how we'd like people working with us to use our various on-line tools.


===== Using revision control: =====
* [[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.
* [[Git Hacks and Tricks]]: Information about using git and/or GitHub that seems useful and maybe not all that obvious.
* [[How to use Eclipse with Hyrax Source Code]] Assuming you have cloned our Hyrax code from GitHub, this explains how to setup eclipse so you can work fairly easily and switch back and forth between the shell, emacs and eclipse.
* [[Migrating source code from SVN to git]]: How to move a large project from SVN to git and keep the history, commits, branches and tags.
 
* [[ReleaseGuide | Making a Source Release]]. Once software is ready for distribution, use this checklist to make sure you do all of the steps needed to make a source release.
* [[ReleaseGuide | Making a Source Release]]. Once software is ready for distribution, use this checklist to make sure you do all of the steps needed to make a source release.
 
* [[ConfigureCentos| How to configure a CentOS machine for production of RPM binaries]] - Updated 12/2014 to include information regarding git.
===== Making specific kinds of packages for release: =====
* [[RPM |Making RPM Distributions]]. Follow these steps to create an RPM distribution of the software.
* [[RPM |Making RPM Distributions]]. Follow these steps to create an RPM distribution of the software.
* [[OLFSReleaseGuide| 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.
* [[OLFSReleaseGuide| 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.
Line 57: Line 53:
* [[XP| Making Windows XP distributions]]. Follow these directions to make Windows XP binaries.
* [[XP| Making Windows XP distributions]]. Follow these directions to make Windows XP binaries.
* [[ReleaseToolbox |Making a Matlab Ocean Toolbox Release]].  Follow these steps when a new Matlab GUI version is ready to be released.
* [[ReleaseToolbox |Making a Matlab Ocean Toolbox Release]].  Follow these steps when a new Matlab GUI version is ready to be released.
Older information - most of these pages describe building Hyrax using source code checked out from our SVN repository. The newer pages (above) that describe using source from GitHub are probably what you want. These pages, however, have some potentially useful information about the third-party code you need if building on an older version of Linux or OS/X.
* [[Eclipse - How to Setup Eclipse in a Shrew Checkout]] This includes some build instructions
* [[Eclipse - How to Setup Eclipse in a Shrew Checkout]] This includes some build instructions
* [[LinuxBuildHostConfig| How to configure a Linux machine to build Hyrax from SVN]]
* [[LinuxBuildHostConfig| How to configure a Linux machine to build Hyrax from SVN]]

Revision as of 19:02, 25 September 2015

Developer Guidelines and Information

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

General development information

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

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.

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 use Eclipse with Hyrax Source Code Assuming you have cloned our Hyrax code from GitHub, this explains how to setup eclipse so you can work fairly easily and switch back and forth between the shell, emacs and eclipse.
  • Making a Source Release. Once software is ready for distribution, use this checklist to make sure you do all of the steps needed to make a source release.
  • How to configure a CentOS machine for production of RPM binaries - Updated 12/2014 to include information regarding git.
  • 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.
Software process issues:
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...