Expand TSML documentation
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1
- Forks
- 1
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 3
Description
The most consistent feedback we got from AGU was about documentation regarding adding datasets, which in the absence of a tool means writing TSML.
We already have a simple tutorial for time series data (#55). One idea expressed was to have similar tutorials for different patterns and shapes of data, like serving data stored as a collection of granules or spectral data.
Contributor guide
No contributing guide indexed for this repository
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 reading the existing simple tutorial for time series data referenced in issue #55 and review how TSML is currently documented. Define tutorials for the requested data patterns, such as collections of granules and spectral data, and consider the documentation complete when users can follow examples for those patterns.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100