Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added to catalog layout for consistent levels #1009

Merged
merged 4 commits into from
Mar 2, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- 'summaries' are now available in the Catalog spec, so both catalogs and collections can make use of it. ([#903](https://github.com/radiantearth/stac-spec/issues/903))
- Recommendation to enable CORS
- A 'visual' option as an asset role.
- Added a best practice recommendation to keep collections at consistent levels.

### Changed

Expand Down
5 changes: 4 additions & 1 deletion best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,8 @@ keep the size of each sub-catalog under a megabyte. If your sub-catalog lists te
should consider an additional way to break it up.

We encourage people to explore new structures of linking data, but the following list is what a number of implementors
ended up doing. Following these recommendations makes for more legible catalogs.
ended up doing. Following these recommendations makes for more legible catalogs, and many tools operate more efficiently
if you follow these recommendations.

1. Root documents (Catalogs / Collections) should be at the root of a directory tree containing the static catalog.
2. Catalogs that are not also Collections should be named `catalog.json` and Collections should be named `collection.json`.
Expand All @@ -404,6 +405,8 @@ ended up doing. Following these recommendations makes for more legible catalogs.
5. Items should be stored in subdirectories of their parent Catalog.
This means that each Item and its assets are contained in a unique subdirectory.
6. Limit the number of Items in a Catalog or sub-Catalog, grouping / partitioning as relevant to the dataset.
7. Use structural elements (Catalog and Collection) consistently across each 'level' of your hierarchy. If levels 2 and 4
have are both only Collections then don't add a Catalog there (and vice versa), or else change every element at that level.
cholmes marked this conversation as resolved.
Show resolved Hide resolved

#### Dynamic Catalog Layout

Expand Down