Clarify terminology of initial release of document version in 3.1.11.1 Version Type - Integer versioning

oasis-tcs / csaf

OASIS CSAF TC: Supporting version control for Work Product artifacts developed by members of TC, including prose specifications and secondary artifacts like meeting minutes and productivity code

https://github.com/oasis-tcs/csaf

Other

152 stars 40 forks source link

Clarify terminology of initial release of document version in 3.1.11.1 Version Type - Integer versioning #791

Open sonnyvanlingen opened 1 month ago

sonnyvanlingen commented 1 month ago

Section 3.1.11.1 Version Type - Integer versioning documents that:

Version 1 defines the initial public release. Each new version where /document/tracking/status is final has a version number incremented by one.

This may be misleading as it implies a release to the general public, while it could also refer to controlled disclosure labeled TLP:GREEN or higher.

My suggestion is to simply remove the word public altogether changing the text to:

Version 1 defines the initial release. Each new version where /document/tracking/status is final has a version number incremented by one.

tschmidtb51 commented 1 month ago

We need to check that this aligns through out the standard.

[ ] /document/tracking/*_release_date
[ ] integer versioning
[ ] semantic versioning
[ ] tests

tschmidtb51 commented 1 month ago

We might want to consider a "to the indended audience" or "to the intended target group" as a replacement for "public".

Version 1 defines the initial release to the intended target group. Each new version where /document/tracking/status is final has a version number incremented by one.

sonnyvanlingen commented 4 weeks ago

Agree with your suggestion @tschmidtb51, this seems more precise.

santosomar commented 1 day ago

Thomas Schmidt moves to adopt the changes presented in Issue: https://github.com/oasis-tcs/csaf/issues/791 The motion was seconded by Sonny. The motion passed.