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
Notational conventions aren't the place to discuss #231
Conversation
There's too much text here that doesn't aid the reader. Delete it to be clear that we're using JSON as the notational convention for examples. If this text was valuable, it should be somewhere else.
draft-ietf-quic-qlog-main-schema.md
Outdated
tips and requirements for these are also listed in this document | ||
({{concrete-formats}}). | ||
The qlog schema can be serialized in many ways (e.g., JSON, CBOR, protobuf, | ||
etc). Serialization examples in this document use JSON ({{!JSON=RFC8259}}). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll keep the definition of serialization example using JSON. But we need to keep the talk about serialization considerations somewhere else
I still feel we should have a "forward reference" here, indicating that we also discuss I-JSON and Streaming JSON considerations in this document, rather than making it seem we only do "pure JSON" due to the examples. Put differently, something like this should still be mentioned in this location imo:
|
But the fact it can be serialized to I-JSON has nothing to do with notational conventions used in this document, because we don't use any I-JSON. |
@LPardue I just pushed a commit with a proposal to split up the original text to keep only a minimal amount in "Notational Conventions" but keep the core message alive in the introduction (which seemed the most logical location for now). I added the "unless otherwise indicated", as there are some examples of JSON-SEQ near the end of the document that obviously don't use RFC8259 notation directly. Please review and if approved, merge :) |
There's too much text here that doesn't aid the reader. Delete it to be
clear that we're using JSON as the notational convention for examples.
If this text was valuable, it should be somewhere else.