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

Moving Binding Mechanism Text to TD #1987

Closed
egekorkan opened this issue Mar 14, 2024 · 2 comments
Closed

Moving Binding Mechanism Text to TD #1987

egekorkan opened this issue Mar 14, 2024 · 2 comments
Labels
Binding topics related to binding of TDs to protocols, media types and platforms document reorganization discussions on how to better structure the specification document document synchronisation topics on how to better synchronize between other WoT documents

Comments

@egekorkan
Copy link
Contributor

egekorkan commented Mar 14, 2024

As we have agreed upon, we will move the binding mechanism of the Binding Templates document to the TD. We can start with a simple copy paste but there are already some overlapping parts. These are mentioned below but we should all have a look to make sure. Note that we do not move the individual bindings, only the core document. This can affect other WG documents but we will start with TD and Bindings first.

By looking at the Table of Contents:

  • Appendix A of TD overlaps with Bindings section 5
  • TD 7.2 and 7.3 have overlaps with the binding mechanism.
  • TD 8.3 overlaps with HTTP binding -> We can remove 8.3 carefully by making sure that there is no information loss.
  • Anything that mentions the forms container needs to be checked. E.g. TD 6.3.9 and 5.3.4.

Otherwise, we can move the whole binding document to a new section. Between sections 7 and 8 of the TD document.

One important question is: What happens to the binding templates core document? First, remove the redundant content. If the registry is a section in TD, we would deprecate the core binding. If not, the binding document becomes the registry (this is fine from process point of view).

@github-actions github-actions bot added the needs-triage Automatically added to new issues. TF should triage them with proper labels label Mar 14, 2024
@egekorkan egekorkan added Binding topics related to binding of TDs to protocols, media types and platforms document reorganization discussions on how to better structure the specification document document synchronisation topics on how to better synchronize between other WoT documents and removed needs-triage Automatically added to new issues. TF should triage them with proper labels labels Mar 14, 2024
@egekorkan
Copy link
Contributor Author

Call of 03 April:

  • Moving the whole document is the consensus of the TF. We will fix the redundant text with follow-up PRs.
  • Section ordering is fine but we can rearrange it all after the tooling.

@egekorkan
Copy link
Contributor Author

Superseeded by #2006

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Binding topics related to binding of TDs to protocols, media types and platforms document reorganization discussions on how to better structure the specification document document synchronisation topics on how to better synchronize between other WoT documents
Projects
None yet
Development

No branches or pull requests

1 participant