ynput / ynput/ayon-documentation
Improve ftrack docs
Open
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 and added correct labels.
Please describe the feature you have in mind and explain what the current shortcomings are?
- Update the ftrack version badge to the newest version
1.2.2 - Update link of ftrack login credentials (currently pointing to kitsu docs)
- Add section on how to use custom ftrack roles with the ftrack addon (when you are for example not an administrator in ftrack)
- Add section on how to generate an API key in ftrack and configure the connection to the addon.
- Add section for setting up the ftrack event server service accounts
Suggested implementation?
No response
Describe alternatives you've considered:
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
Locate the existing ftrack documentation pages and identify where the version badge and login-credentials link are defined. Update those items and add sections covering custom roles, API-key generation and addon configuration, and event-server service accounts; verify the documentation renders correctly and all links work.
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
- 35/100