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 documentation for new schema development/proposal process #1429

Merged

Conversation

ssteinbach
Copy link
Collaborator

Adds a new documentation tutorial page outlining a process for proposing and developing new schemas for OTIO, based on several recent successful projects.

Closes #769

@ssteinbach ssteinbach added this to the Public Beta 16 milestone Sep 29, 2022
@codecov-commenter
Copy link

codecov-commenter commented Sep 29, 2022

Codecov Report

Merging #1429 (6b4ca9f) into main (b193168) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1429   +/-   ##
=======================================
  Coverage   86.08%   86.08%           
=======================================
  Files         201      201           
  Lines       21051    21051           
  Branches     2461     2461           
=======================================
  Hits        18121    18121           
  Misses       2328     2328           
  Partials      602      602           
Flag Coverage Δ
py-unittests 86.08% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b193168...6b4ca9f. Read the comment docs.

Copy link
Collaborator

@meshula meshula left a comment

Choose a reason for hiding this comment

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

some wordsmithing as inline suggestions...

docs/tutorials/developing-a-new-schema.md Outdated Show resolved Hide resolved
docs/tutorials/developing-a-new-schema.md Outdated Show resolved Hide resolved
docs/tutorials/developing-a-new-schema.md Outdated Show resolved Hide resolved
docs/tutorials/developing-a-new-schema.md Outdated Show resolved Hide resolved
docs/tutorials/developing-a-new-schema.md Outdated Show resolved Hide resolved
docs/tutorials/developing-a-new-schema.md Outdated Show resolved Hide resolved
docs/tutorials/developing-a-new-schema.md Outdated Show resolved Hide resolved
docs/tutorials/developing-a-new-schema.md Outdated Show resolved Hide resolved
ssteinbach and others added 7 commits September 29, 2022 11:09
Co-authored-by: Nick Porcino <meshula@hotmail.com>
Signed-off-by: Stephan Steinbach <61017+ssteinbach@users.noreply.github.com>
Co-authored-by: Nick Porcino <meshula@hotmail.com>
Signed-off-by: Stephan Steinbach <61017+ssteinbach@users.noreply.github.com>
Co-authored-by: Nick Porcino <meshula@hotmail.com>
Signed-off-by: Stephan Steinbach <61017+ssteinbach@users.noreply.github.com>
Co-authored-by: Nick Porcino <meshula@hotmail.com>
Signed-off-by: Stephan Steinbach <61017+ssteinbach@users.noreply.github.com>
Co-authored-by: Nick Porcino <meshula@hotmail.com>
Signed-off-by: Stephan Steinbach <61017+ssteinbach@users.noreply.github.com>
Co-authored-by: Nick Porcino <meshula@hotmail.com>
Signed-off-by: Stephan Steinbach <61017+ssteinbach@users.noreply.github.com>
Co-authored-by: Nick Porcino <meshula@hotmail.com>
Signed-off-by: Stephan Steinbach <61017+ssteinbach@users.noreply.github.com>
@ssteinbach ssteinbach marked this pull request as ready for review September 29, 2022 18:11
Copy link
Collaborator

@meshula meshula left a comment

Choose a reason for hiding this comment

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

lgtm

@meshula meshula merged commit 238e64c into AcademySoftwareFoundation:main Sep 29, 2022
MichaelPlug pushed a commit to MichaelPlug/OpenTimelineIO that referenced this pull request Aug 5, 2023
…ySoftwareFoundation#1429)

* add developing a new schema doc

Signed-off-by: Stephan Steinbach <61017+ssteinbach@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nick Porcino <meshula@hotmail.com>
Signed-off-by: Stephan Steinbach <61017+ssteinbach@users.noreply.github.com>
Signed-off-by: Michele Spina <michelespina96@gmail.com>
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.

Schema Addition How-to
3 participants