docs(config): collection_url is required for nested collections (#257) - #261
Merged
Conversation
…ons (#257) The Collections table described collection_url as only for 'private or external catalogs', but the framework resolves bare collection_ids by scanning only the root catalog's direct child links — it never recurses into parent/container collections. A collection nested under a parent (even in the same public catalog) silently never loads without an explicit collection_url (the miss is only a console.warn). This caused ca-30x30 to silently drop 15 of 17 collections. Update the table row, add a 'Nested collections' subsection (how to detect, how to find the URL, the maintenance trade-off), and a troubleshooting note.
Coverage Report
File CoverageNo changed files found. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #257.
Problem
docs/guide/configuration.mddescribedcollection_urlas only "useful for private or external catalogs." That's misleading and caused a real silent failure.Confirmed against
dataset-catalog.jsload(): barecollection_ids are resolved by filtering only the root catalog'srel=childlinks — there is no recursion into parent/container collections. A collection nested under a parent (even in the same public catalog) is never found, and the miss only logs aconsole.warn— no user-visible error.Incident (ca-30x30): 15 of 17 collections were configured with bare
collection_ids because they appeared in flatlist_datasetsoutput. They live under parent collections and silently dropped; only the 2 carrying an explicitcollection_urlrendered.Fix (docs only)
collection_urltable row: required for any non-direct-child collection; recommended for top-level too (skips the slow walk).links[rel=child]), how to find the URL (the collection JSON'sselfhref), and the rename/move maintenance trade-off.collection_id→ probably nested, setcollection_url.The new
#nested-collectionsanchor is referenced from the table row.