NASA-IMPACT / NASA-IMPACT/veda-docs

Revise documentation of cog_default in collection summaries

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

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
10
Forks
16
Avg merge
2d 31m
Merged PRs (30d)
4

Description

What

STAC collections now support multi asset items and no longer enforce cog_default assets be included in each item. Cog_default summaries have been removed from the automated dataset summaries as well (while still valid when present, summaries of cog_default statistics are no longer guaranteed in all collections). Review documentation to clarify.

Note

Render metadata are now included in most of the collections in veda-data and these visualization hints may be useful when updating docs.

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

Review the documentation that describes cog_default in collection summaries, then compare it with the collection metadata under veda-data/ingestion-data/collections. Update the documentation to explain that cog_default summaries are optional and no longer guaranteed, while noting that render metadata may provide useful visualization hints. Done means the documented behavior matches the current collections.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.