Skip to content

Commit 53d59ae

Browse files
Documentation updates (#153)
* Create CREDITS.md Move credits information from being embedded in an html page to its own md file * Have setup.html link to credits instead of detail them * Create DEPLOY_INSTALL.md From information in setup.html * Update setup.html with link to initial setup instructions page * Create DEPLOY_UPDATE.md * Change the update section to a link to the new update installation page * Create CONTRIBUTING.md * Create PROGRAMMER_GUIDE.md * Move the dependency credits back to the setup.html file remove the programmer's guide from setup.html since its now in its own file * Create GOVERNANCE.md * Create TECHNICAL_BOARD.md * Create PRIORITY_PROJECTS.md * Clean up some formatting in programmer's guide * Update README.md * Fix some links * Update release date of the latest erddap.war file * Create LICENSE * Update license section Note the link to the full license text will work when this branch is merged * Update README.md * Take a pass at adding TM to html pages * Add tm to ERDDAP in md files * Update PROGRAMMER_GUIDE.md * Add TMs after merge * Update README.md * Add note about csh to deploy instructions * Remove duplicated docker readme and fix formatting of Technical Board documentation
1 parent 0406148 commit 53d59ae

27 files changed

+3647
-4181
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ A clear and concise description of what you expected to happen.
2424
If applicable, add screenshots to help explain your problem.
2525

2626
**Server**
27-
- What ERDDAP server? If you're the admin, please provide what version of ERDDAP, Tomcat, and Java you are using.
27+
- What ERDDAP server? If you're the admin, please provide what version of ERDDAP, Tomcat, and Java you are using.
2828

2929
**Desktop (please complete the following information):**
3030
- OS: [e.g. iOS]

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing to ERDDAP™
2+
## Reporting an issue
3+
**Do not open up a GitHub issue if the bug is a security vulnerability**, and instead to refer to our [security policy](SECURITY.md). Any sensitive issues will be removed from the public tracker.
4+
5+
Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/ERDDAP/erddap/issues).
6+
7+
If you have a feature request make a Github Discussion (see below for more information).
8+
9+
If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ERDDAP/erddap/issues/new). Be sure to include a title and clear description, as much relevant information as possible, and directions for reproducing the issue or an ERDDAP™ server demonstrating the expected behavior that is not occurring.
10+
## Fixing an Issue
11+
Open a new GitHub pull request (PR) with the patch.
12+
13+
Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
14+
15+
Before submitting, please read the Programmer Guide (coming soon) guide to know more about coding conventions.
16+
## Adding a new feature
17+
Suggest your change in the [ERDDAP™ GitHub discussions](https://github.com/ERDDAP/erddap/discussions) and start writing code. Before creating the GitHub discussion, it might be helpful to read this [guidance](https://github.com/ERDDAP/erddap/discussions/93#discussion-4920427).
18+
19+
Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
20+
## For technical questions
21+
See the [ERDDAP™ GitHub discussions](https://github.com/ERDDAP/erddap/discussions).
22+
## For ERDDAP™ server admin support
23+
See the [ERDDAP™ users Google group](https://groups.google.com/g/erddap).

CREDITS.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
[Credits](#credits)
2+
-------------------
3+
Contributions to ERDDAP™ code
4+
* [MergeIR](#submittedCode)
5+
[EDDGridFromMergeIRFiles.java](https://erddap.github.io/setupDatasetsXml.html#EDDGridFromMergeIRFiles) was written and contributed by Jonathan Lafite and Philippe Makowski of R.Tech Engineering (license: copyrighted open source). Thank you, Jonathan and Philippe!
6+
 
7+
* TableWriterDataTable
8+
[.dataTable (TableWriterDataTable.java)](https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#fileType) was written and contributed by Roland Schweitzer of NOAA (license: copyrighted open source). Thank you, Roland!
9+
 
10+
* json-ld
11+
The initial version of the [Semantic Markup of Datasets with json-ld (JSON Linked Data)](#jsonld) feature (and thus all of the hard work in designing the content) was written and contributed (license: copyrighted open source) by Adam Leadbetter and Rob Fuller of the Marine Institute in Ireland. Thank you, Adam and Rob!
12+
 
13+
* orderBy
14+
The code for the [orderByMean filter](https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByMean) in tabledap and the extensive changes to the code to support the [_variableName/divisor:offset_ notation](https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByDivisorOptions) for all orderBy filters was written and contributed (license: copyrighted open source) by Rob Fuller and Adam Leadbetter of the Marine Institute in Ireland. Thank you, Rob and Adam!
15+
 
16+
* Borderless Marker Types
17+
The code for three new marker types (Borderless Filled Square, Borderless Filled Circle, Borderless Filled Up Triangle) was contributed by Marco Alba of ETT / EMODnet Physics. Thank you, Marco Alba!
18+
 
19+
* Translations of messages.xml
20+
The initial version of the code in TranslateMessages.java which uses Google's translation service to translate messages.xml into various languages was written by Qi Zeng, who was working as a Google Summer of Code intern. Thank you, Qi!
21+
 
22+
* orderBySum
23+
The code for the [orderBySum filter](https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderBySum) in tabledap (based on Rob Fuller and Adam Leadbetter's orderByMean) and the Check All and Uncheck All buttons on the EDDGrid Data Access Form were written and contributed (license: copyrighted open source) by Marco Alba of ETT Solutions and EMODnet. Thank you, Marco!
24+
 
25+
* Out-of-range .transparentPng Requests
26+
ERDDAP™ now accepts requests for .transparentPng's when the latitude and/or longitude values are partly or fully out-of-range. (This was ERDDAP™ GitHub Issues #19, posted by Rob Fuller -- thanks for posting that, Rob.) The code to fix this was written by Chris John. Thank you, Chris!
27+
 
28+
* Display base64 image data in .htmlTable responses
29+
The code for displaying base64 image data in .htmlTable responses was contributed by Marco Alba of ETT / EMODnet Physics. Thank you, Marco Alba!
30+
 
31+
* nThreads Improvement
32+
The nThreads system for EDDTableFromFiles was significantly improved. These changes lead to a huge speed improvement (e.g., 2X speedup when nThreads is set to 2 or more) for the most challenging requests (when a large number of files must be processed to gather the results). These changes will also lead to a general speedup throughout ERDDAP™. The code for these changes was contributed by Chris John. Thank you, Chris!

0 commit comments

Comments
 (0)