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

Conversation

cholmes
Copy link
Contributor

@cholmes cholmes commented Feb 24, 2021

Related Issue(s): #949

Proposed Changes:

  1. Added best practice to catalog layout for consistent levels

PR Checklist:

  • This PR is made against the dev branch (all proposed changes except releases should be against dev, not master).
  • This PR has no breaking changes.
  • I have added my changes to the CHANGELOG or a CHANGELOG entry is not required.

@cholmes cholmes added this to the 1.0.0-RC.1 milestone Feb 24, 2021
@cholmes cholmes self-assigned this Feb 24, 2021
@cholmes cholmes linked an issue Feb 24, 2021 that may be closed by this pull request
@@ -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

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

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.

@cholmes
Copy link
Contributor Author

cholmes commented Mar 2, 2021

Ok, new attempt is up.

Copy link
Collaborator

@lossyrob lossyrob left a comment

Choose a reason for hiding this comment

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

Suggested some wording changes to make it a bit more clear.

best-practices.md Outdated Show resolved Hide resolved
Co-authored-by: Rob Emanuele <[email protected]>
@m-mohr m-mohr merged commit 066bd81 into dev Mar 2, 2021
@m-mohr m-mohr deleted the consistent-levels branch March 2, 2021 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add catalog best practice for keeping collections at consistent levels
3 participants