AcademySoftwareFoundation / AcademySoftwareFoundation/OpenTimelineIO

Document how to make a new adapter via the template repo

Open
#1,377 2 comments 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
C++
Stars
2k
Forks
351
Avg merge
1d 12h
Merged PRs (30d)
1

Description

Currently the OTIO documentation leads people to make new adapters in the contrib folder within the OTIO repo, but we have decided to move those adapters into separate repos. We should update the documentation to explain how to use the template repo: https://github.com/OpenTimelineIO/otio-plugin-template to make a new adapter.

Contributor guide

Open the contributing guide

Research direction

Start by locating the current OTIO documentation that directs contributors to create adapters in the contrib folder. Read the otio-plugin-template repository and update the guidance to explain how to use it for a new adapter in a separate repository. Done means the documentation reflects the decided workflow and no longer directs users to create adapters in contrib.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.