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

Errata fixes #2008

Merged
merged 1 commit into from
May 2, 2024
Merged

Errata fixes #2008

merged 1 commit into from
May 2, 2024

Conversation

egekorkan
Copy link
Contributor

@egekorkan egekorkan commented Apr 29, 2024

I wanted to fix #2007 but I have noticed quite a bit of problems. We were not using the correct issue labels and now that I have changed to the correct ones, we have very long erratas. The automatically loaded w3c script assumes that a repo has one specification version. So now our errata is wrong: https://w3c.github.io/wot-thing-description/errata11.html

Some ways forward:

  • Option 1. Do not use the official W3C labels and create the rendered version ourselves (do not include the script)
  • Option 2. Create a new repo for each REC version
  • Option 3. Fork that script and filter based on TD version etc. This seems the best approach at this point but we will need to agree together.
  • Option 4. Use the official labels but do not include the script and create the rendered version ourselves
  • Option 5. Contribute back to the script: https://github.com/w3c/display_errata/

Notes:

  • Until we solve the issue, we will not use the labels that produce unwanted text in an official document
  • https://www.w3.org/2023/Process-20230612/#erratum gives a high-level description of the process.
  • The entire WG should be aware that they should not use Errata label without a TF resolution.
  • This procedure should be replicated for Discovery and Architecture. We can agree and test it as the TD TF and show the results in the main call.

Screenshot of the errata document with correct labels:
image

A PDF-print of the page to show the issues:
Open Errata for the Web of Things (WoT) Thing Description 1.1 Specification.pdf

@egekorkan egekorkan marked this pull request as ready for review May 2, 2024 13:31
@egekorkan
Copy link
Contributor Author

TD call on 2 May:

  • We will merge the PR since it fixes the static version already
  • For the way forward, we will ask on https://github.com/w3c/display_errata/ if we can change the script to include spec version. If yes, we will take option 5. If not, we will try option 3. Option 1 is always a fallback.

@egekorkan egekorkan merged commit 6c152ce into main May 2, 2024
1 check passed
@egekorkan egekorkan deleted the ege-errata-fixes branch September 18, 2024 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Issues in Errata Document
1 participant