ynput / ynput/ayon-documentation
Ftrack Actions Documentation - Adding custom actions to ayon
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 12
- Forks
- 13
- PR merge metrics
- No merged PRs in 30d
Description
Is there an existing issue for this?
- I have searched the existing issues.
Please describe the feature you have in mind and explain what the current shortcomings are?
Currently missing documentation on how to register new ftrack actions alongside ayon's preinstalled ones.
It seems like it is more complex than simply adding the action to the ftrack/event_handlers_user/ folder so could probably use documenting.
How would you imagine the implementation of the feature?
Add to existing ftrack actions doc
Are there any labels you wish to add?
- I have added the relevant labels to the enhancement request.
Describe alternatives you've considered:
No response
Additional context:
No response
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing ftrack actions documentation and inspect the ftrack/event_handlers_user/ folder to determine how custom actions are registered alongside Ayon's preinstalled actions. Done means the existing documentation explains the complete registration process and distinguishes it from simply adding an action to that folder.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100