Adds the Catalog Best Practices page, linked from the Symbols page in the spec. #272
Conversation
This file contains 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
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.
Description of changes:
Recently we were made aware of an issue where a producer of binary Ion data began encoding with a new shared symbol table, and a consumer of that data was unable to read it because their catalog implementation was hard-coded to return only the symbol table with which the data had previously been encoded.
The goal of this new "Catalog Best Practices" page is to make it clear that shared symbol table usage is a contract between the application that produces Ion data and the application(s) that consume that data, and to provide high-level guidance for implementing correct Catalog implementations depending on the chosen contract.
Rendered view:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.