locationtech / locationtech/geomesa
Add documentation and examples for implementing custom Javascript functions for converters
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1.5k
- Forks
- 446
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 31
Description
Add documentation and examples for implementing custom Javascript functions for converters
From Gitter:
Patrick Dufour @pjdufour
Yeah some minor changes come to mind (in no specific order). (1) docs for using GEOMESA_EXTRA_CLASSPATHS isn't clear it can be used to point to folder of javascript functions, (2) support for javascript arrow functions (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions), (3) maybe ship with a scripts or lib/scripts folder with an example function or two (get.js ?)
Original JIRA Issue: https://geomesa.atlassian.net/browse/GEOMESA-2226
Key: GEOMESA-2226
Type: Improvement
Priority: Major
Status: To Do
Resolution: Unresolved
Reporter: James Hughes
Created: Wed, 21 Mar 2018 16:57:10 -0400
Updated: Wed, 21 Mar 2018 16:57:10 -0400
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing converter documentation and references to GEOMESA_EXTRA_CLASSPATHS, then review how custom JavaScript functions are loaded. Document using that classpath for JavaScript folders, add converter examples such as get.js, and clarify whether arrow-function support is part of the requested change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100