lasp / lasp/developer-guide

Complete content for NetCDF guide

Open
#29 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
3
Forks
9
PR merge metrics
No merged PRs in 30d

Description

The NetCDF guide was created pulling content written by Doug Lindholm in Confluence. Confluence page

Some additional content is needed to provide context and explain how this file format is being used at LASP. I added a warning at the top of the guide noting that it's incomplete.

Details still needed:

Expand overview section and explain bullet points
Expand purpose section
Expand on options available
Expand on how to apply the guide
Include information for compliance checkers, especially since this is the convention being pushed by the NASA Earth Science Data Systems and that changes what's required vs. useful attributes

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing NetCDF guide and compare it with the linked Confluence page. Review the overview, purpose, options, and application sections, then research the compliance-checker expectations associated with NASA Earth Science Data Systems. The work is complete when these sections provide the requested context and distinguish required attributes from useful ones.

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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.