Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved ftrack admin docs #305

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Dreamink-Official
Copy link

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
Contributor

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
@Dreamink-Official
Copy link
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
Contributor

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.

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