extensive expansion of MediaConvert adapter docs

samvera-labs / active_encode

Declare encode job classes that can be run by a variety of encoding services

Other

6 stars 8 forks source link

extensive expansion of MediaConvert adapter docs #101

Closed jrochkind closed 2 years ago

jrochkind commented 2 years ago

I had some trouble figuring out how to use the adapter, so I thought I'd write some extensive documentation to try save other people the trouble with better explanation of what's what, and also flesh out the API docs.

Some of the behavior seems to me like maybe it's developer ergonomics could be improved, but this PR just tries to doc what's there right now.

@mbklein @cjcolvar I think it would be awesome if you both gave this a once-over to make sure we're all on the same page.

jrochkind commented 2 years ago

Thank you for your reviews! I took your copyedits @cjcolvar and will merge when CI is green.

jrochkind commented 2 years ago

Oh, one question for the future, @cjcolvar , is whether we want to handle these "not actual dependency dependencies" in a more formal way. Actually I'll go and make another ticket on that...