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

Remove Previous Version from .bs file #169

Merged
merged 1 commit into from Apr 22, 2021
Merged

Conversation

mkruisselbrink
Copy link
Collaborator

@mkruisselbrink mkruisselbrink commented Apr 21, 2021

When publishing to WD the correct previous version gets added anyway, and having (an incorrect) previous version mentions in the .bs file actually breaks auto-publishing.

This should fix "Retrieved "previous" and "latest" documents, but their contents don't match. errors from echidna.


Preview | Diff

When publishing to WD the correct previous version gets added anyway, and having (an incorrect) previous version mentions in the .bs file actually breaks auto-publishing.
@marcoscaceres
Copy link
Member

BS'a docs say

Previous Version can contain either a URL to a previously-published version (such as versions published on w3.org/TR), or the value from biblio or from biblio my-spec-1.

So maybe "from biblio" should go there?

@mkruisselbrink
Copy link
Collaborator Author

BS'a docs say

Previous Version can contain either a URL to a previously-published version (such as versions published on w3.org/TR), or the value from biblio or from biblio my-spec-1.

So maybe "from biblio" should go there?

That seems to work to get the correct version in the ED version, but with the way spec-prod invokes bikeshed will still result in the previous version being listed twice (since spec-prod also passes the latest previous version via the command line). I guess it should at least let echidna not complain?

@mkruisselbrink
Copy link
Collaborator Author

So I guess (without changing spec-prod) we can either have previous version in the ED, but have it twice in the WD. Or alternatively just have previous version in the WD and not in the ED at all. Do EDs typically list previous versions?

@marcoscaceres
Copy link
Member

I guess it should at least let echidna not complain?

Might be enough.

Do EDs typically list previous versions?

No, not typically. But maybe ok if it's not too confusing 🤷 ?

Cc'ing @sidvishnoi, as he might be interested in this discussion.

@sideshowbarker
Copy link
Contributor

Currently the way that works with spec-prod is to completely drop the Previous Version part from the source, and let spec-prod add it. For example, see https://github.com/w3c/webappsec-csp/pull/484/files.

So the current patch in this PR is doing the right thing.

Do EDs typically list previous versions?

I don’t know if most EDs have Previous Version links but regardless it doesn’t seem useful for EDs to have Previous Version links.

The Previous Version links have some usefulness in the TR publications, and so outside of the fact they’re required by pubrules for TR publication, it also makes some sense as far as usability/UX for readers to have them there.

But I don’t think that really holds for EDs.

So I guess (without changing spec-prod) we can either have previous version in the ED, but have it twice in the WD. Or alternatively just have previous version in the WD and not in the ED at all.

It seems fine to have at the Previous Version info just in the WD but the ED. It doesn’t seem like readers are losing anything by us not having the Previous Version link in the ED.

@sideshowbarker sideshowbarker merged commit d56cd86 into main Apr 22, 2021
@sideshowbarker sideshowbarker deleted the mkruisselbrink-patch-1 branch April 22, 2021 00:55
@sideshowbarker
Copy link
Contributor

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.

None yet

3 participants