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

Add support for errata in Req track documents (e.g. DCAT) #545

Closed
davebrowning opened this issue Nov 7, 2018 · 6 comments
Closed

Add support for errata in Req track documents (e.g. DCAT) #545

davebrowning opened this issue Nov 7, 2018 · 6 comments
Assignees
Labels

Comments

@davebrowning
Copy link
Contributor

davebrowning commented Nov 7, 2018

Its likely that our deliverables will have errors that only come to light after ratification. There are a number of ways this has been addressed in use by other groups. The easiest seems to be a link to a simple page where potential errata can be recorded and/or processed (subject to W3C procedure, of course). This is the approach used for 2014 DCAT recommendation here, and something similar is used for Data on the Web Best Practices.

At a minimum, the suggestion is to provide the link in the Rec document, and a holding page as needed.

(The discussion at #169 is probably relevent for background.)

@davebrowning
Copy link
Contributor Author

On investigation (and playing around with respec as well as reading the documentation) it only makes sense to do this once we've reached REQ (or perhaps PER). The relevant hook will be added to config.js, but commented out.

@davebrowning
Copy link
Contributor Author

We will need to/should provide an (initially) empty template errata page as per W3C style guide but this is only relevent after reaching REC status

@andrea-perego
Copy link
Contributor

Should we move this one to future work?

@andrea-perego andrea-perego added future-work issue deferred to the next standardization round and removed Editorial labels Oct 30, 2019
@aisaac
Copy link
Contributor

aisaac commented Nov 4, 2019

Lesson learnt from past experience: creating a fully fledged errata page is probably not needed for PR, but it's good to include a URL for it in the spec document (ie the main DCAT spec) now, though, even if it's a stub. Such link obviously helps readers find the fixes you want them to find. And adding the link at later stage in the process may prove more difficult! (especially if you forget it before it moves to Rec...)

@riccardoAlbertoni
Copy link
Contributor

Some discussion about the errata document is in progress under issue #1182 and PR #1209.

This was referenced Jan 28, 2020
@andrea-perego
Copy link
Contributor

An errata document is available for DCAT 2, and linked to from the spec:

https://w3c.github.io/dxwg/errata/

See #1182 & #1209

I'm closing this issue.

@andrea-perego andrea-perego removed the future-work issue deferred to the next standardization round label Mar 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants