8000 Give concrete guidance on how to extend qlog · Issue #405 · quicwg/qlog · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Give concrete guidance on how to extend qlog #405

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

Jump to bottom
Open
rmarx opened this issue Mar 4, 2024 · 1 comment
Open

Give concrete guidance on how to extend qlog #405

rmarx opened this issue Mar 4, 2024 · 1 comment
Assignees
@rmarx
Labels
editorial

Comments

@rmarx
Copy link
Contributor
rmarx commented Mar 4, 2024 •
edited
Loading

With #417 and the additional-schema proposal, we're moving to a good state for qlog's extensibility.

However, we feel additional prose is needed to make people make good use of this extensibility. Without it, we will mainly have the proper CDDL structures and some scattered prose, but no clear flowcharts/lists or similar.

For example, we can add TODOs for different use cases:

  • If you want to add a fully new protocol, do xyz
  • If you want to add new fields to an existing event, do abc
  • If you want to add new options to an ENUM, do def

This can only be done after the extensibility stuff is properly done though, so this issue is to remind us later ;)
@rmarx rmarx self-assigned this Jun 24, 2024
@LPardue
Copy link
Member
LPardue commented Mar 12, 2025 •
edited
Loading

Marking this as editorial.

I would suggest a fairly light touch here. I.e. add some short text in the main schema that describes the key points you outline. There's an increasing number of examples of actually using qlog extensibility that I think there's ample examples of these things without needing too many words or fake examples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rmarx rmarx

Labels
editorial
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rmarx @LPardue
0