search

cta-wave / mezzanine

This repo contains scripts that will build annotated test content from specific source content, compatible with the WAVE device playback test suite.
BSD 3-Clause "New" or "Revised" License
2 stars 2 forks source link

An Annotations specification with version is required #31

Closed mbergman42 closed 10 months ago

mbergman42 commented 3 years ago

The Mezzanine content annotations need to be documented in a formal spec with revision control. The spec doesn't need to be public but the details do need to be written down. As we partner with other groups about content, we'll need to share the Mezzanine content specifications. See also the new bit pattern (https://github.com/cta-wave/mezzanine/issues/28), which should be included where used.

jpiesing commented 3 years ago

@mbergman42 I moved this to the mezzanine project since I think that's where it belongs.

nicholas-fr commented 3 years ago

I believe this makes sense, especially now that we are close to a first baseline set of mezzanine content. We discussed version control for the mezzanine streams (c.f. process proposal #30), so having a corresponding spec is logical. I will write up a first draft proposal.

cta-source commented 3 years ago

We have a v0.1 specification document underway. The first draft captures the information in https://github.com/cta-wave/mezzanine/issues/28. Information will be added as a background task as the project continues.

jpiesing commented 3 years ago

@nicholas-fr @cta-source Please decide offline between the two of you what should happen next with this & who owns the action?

cta-source commented 3 years ago

I believe the draft specification is well on its way & has become a usable tool. I suggest we close this issue. However, @nicholas-fr and I should look to release the draft spec with the current mezzanine release, and we should plan to have a new mezz spec release with each mezz release.

nicholas-fr commented 2 years ago

Here is the latest draft specification for review. For now this contains the mezzanine content requirements.

WAVE Test Content Format Specification v0.3e.docx

rbouqueau commented 2 years ago

Following our discussion here is a version adding a paragraph on the content folder naming.

WAVE.Test.Content.Format.Specification-RBO.v0.4.docx

gitwjr commented 1 year ago

@cta-source Review with @wilaw

gitwjr commented 1 year ago

@nicholas-fr will check the document to see if the specification correctly matches the folder structure. If so, the issue can be closed.

gitwjr commented 1 year ago

@nicholas-fr Believe this is done. Will check and close.

gitwjr commented 10 months ago

Closed as done. It appears the final specification includes the information in Annex C. May be reopened if necessary.