Skip to content

added to catalog layout for consistent levels #1009

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Mar 2, 2021
Merged

added to catalog layout for consistent levels #1009

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
17cd376
added to catalog layout for consistent levels
cholmes Feb 24, 2021
0f4f63b
merged dev
cholmes Mar 2, 2021
c709643
attempted rewrite
cholmes Mar 2, 2021
3af0a27
Update best-practices.md
cholmes Mar 2, 2021
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,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
6 changes: 5 additions & 1 deletion best-practices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,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 @@ -274,6 +275,9 @@ 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. In a nested hierarchy of catalogs and collections make the different levels 'homogeneous' - all catalogs or all collections.
Copy link
Collaborator

@m-mohr m-mohr Feb 24, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds a bit like there should be only one level of collections, although it should also be fine to have e.g. all levels being collections (although an Item can only link to one collection).

Copy link
Contributor Author

@cholmes cholmes Feb 24, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, I'll try again. I was thinking about that as I was writing it but didn't manage to find a way to succinctly get it across. This was weirdly more challenging to explain than I was expecting.

This means if you have a catalog (level 1) that links to 5 collections (level 2) that each link to more catalogs (level 3) that
link to items and catalogs then you should only add more collections at level 2, and only catalogs at level 1, 3 and beyond.

### Dynamic Catalog Layout

Expand Down