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

Change title to editor's draft #102

Merged
merged 1 commit into from
Mar 5, 2024
Merged

Change title to editor's draft #102

merged 1 commit into from
Mar 5, 2024

Conversation

awoie
Copy link
Contributor

@awoie awoie commented Feb 12, 2024

Fixes #70

@awoie awoie changed the title Chang title to editor's draft Change title to editor's draft Feb 12, 2024
@awoie awoie requested a review from paulbastian February 12, 2024 16:29
@awoie awoie requested a review from jogu February 12, 2024 17:10
@Sakurann
Copy link
Collaborator

@tlodderstedt @jogu we need to agree that this is a convention. I think Torsten had some concerns about having to re-generate html before publishing a new draft to openid.net.
I had concerns that when we published VCI to openid.net @selfissued said that before being published to openid.net, the .md with a latest version number needs to be checked in to the GH. Meaning, every time we want to publish a new draft number to openid.net, there will be two PRs, changing editors draft to - <draft number> and vice versa. if we agree there is no need to do that, it could maybe work.

@jogu
Copy link
Collaborator

jogu commented Feb 13, 2024

Having to do two pull requests to update the titles when publishing a numbered revision is potentially an acceptable overhead given there is a definitive advantage of it being clear that versions of the specs generated from the pipelines are not stable versions despite being numbered.

The ultimate aim of OIDF is to automate the publishing process for numbered drafts, so that may then remove the need for manual steps to change the title.

Copy link
Collaborator

@tlodderstedt tlodderstedt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see any benefit in not having the revision numbers in the markdown. So I would like to stick to the approach of having draft numbers and cutting new draft numbers once we publish a stable WG draft at openid.net.

@paulbastian
Copy link
Contributor

The problem that I see is that people will see different versions of the spec over time with the number in the title but with different contents.

Also, people reported that they did not understand what the latest efforts draft is and how to distinguish from stable versions.

@selfissued
Copy link
Member

I agree with @tlodderstedt that it's cleaner to keep the draft numbers in the spec at all times.

@paulbastian, people will only see the spec changing within a draft number if we point them to the editors' draft. That's fine within the working group but we shouldn't be sharing those transient drafts outside the working group. We should be pointing people outside the working group to the stable versions published at openid.net/specs/.

@jogu
Copy link
Collaborator

jogu commented Feb 16, 2024

@paulbastian, people will only see the spec changing within a draft number if we point them to the editors' draft. That's fine within the working group but we shouldn't be sharing those transient drafts outside the working group. We should be pointing people outside the working group to the stable versions published at openid.net/specs/.

We do not limit access to the https://openid.github.io/OpenID4VP/openid-4-verifiable-presentations-wg-draft.html version of the spec to working group members, and people who are not working group members frequently end up there. It is not at all clear to them what the status of the document is. Having it look exactly the same as a version published on openid.net/specs seems like it will cause a lot of confusion.

@paulbastian
Copy link
Contributor

I made this suggestion because people from the ISO community told me that they were confused about this and they rely on OpenID4VP, so this is actual, real feedback.

This is my last point on this issue, feel free to do what you think is right.

@Sakurann
Copy link
Collaborator

I think it is cleaner to have "editor's draft" in openid.bitbucket.io version. My only concern was doing two PRs every single time, but Joseph's comment here convinced me it's ok (guess I am also volunteering him to help with these PRs ;) )

Having to do two pull requests to update the titles when publishing a numbered revision is potentially an acceptable overhead given there is a definitive advantage of it being clear that versions of the specs generated from the pipelines are not stable versions despite being numbered.

The ultimate aim of OIDF is to automate the publishing process for numbered drafts, so that may then remove the need for manual steps to change the title.

@jogu
Copy link
Collaborator

jogu commented Mar 5, 2024

Editorial, open for many weeks and 5 approvals, merging.

@jogu jogu merged commit 25a88fc into main Mar 5, 2024
2 checks passed
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.

clarify this is an editor's draft in the title
7 participants