Skip to content

Improved ftrack admin docs#305

Closed
technicaldirector wants to merge 5 commits into
ynput:mainfrom
technicaldirector:main
Closed

Improved ftrack admin docs#305
technicaldirector wants to merge 5 commits into
ynput:mainfrom
technicaldirector:main

Conversation

@technicaldirector
Copy link
Copy Markdown

Changelog Description

I found it challenging to set up the connection between AYON and Ftrack. To address this, I enhanced the documentation in my PR to make it more precise.

@MustafaJafar
Copy link
Copy Markdown
Member

MustafaJafar commented Nov 21, 2024

Hello @Dreamink-Official,
Thank you for your contribution.


Generally speaking,
I think the ftrack docs needs an overhaul. e.g. Ftrack credentials in the Login section is pointing to ayon kitsu addon docs.

Also, the ftrack badge is referring to 0.2.4 version while the current version is 1.2.2.
image

For information, I've started creating issues for updating different addon docs like this one for deadline
#264


Notes for your PR:
The current workflow is to create an issue (from here) and add some bullet points about things to change.

Next step: to create branch to apply your fix, it's recommended to use a descriptive name e.g. improve-ftrack-docs
Then you push that and create a PR.

Changed the login links
Changed ftrack badge version
@technicaldirector
Copy link
Copy Markdown
Author

Hey @MustafaJafar, thanks for highlighting additional areas in the docs that need improvement! I've created an issue (#306) and included the points you mentioned.

If you come across anything else that could be improved, feel free to reach out anytime!

By the way, is this workflow—creating an issue and linking the PR to it—standard across all AYON repositories, or is it specific to the documentation repo?

@MustafaJafar
Copy link
Copy Markdown
Member

Hey @MustafaJafar, thanks for highlighting additional areas in the docs that need improvement! I've created an issue (#306) and included the points you mentioned.

If you come across anything else that could be improved, feel free to reach out anytime!

Thank you for your contribution.

By the way, is this workflow—creating an issue and linking the PR to it—standard across all AYON repositories, or is it specific to the documentation repo?

yes, it's standard across all AYON repos.

@MustafaJafar
Copy link
Copy Markdown
Member

Thank you for your contribution. Unforunatly, it won't be possible to merge this PR as artist and admin docs are moved to our new help center. As a result, they'll be removed from this repo #370.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants