search

shotgunsoftware / python-api

A Python-based library for accessing Flow Production Tracking API.
https://developer.shotgridsoftware.com/python-api
Other
306 stars 198 forks source link

[duguids] SG-29350 adding video to installation doc #271

Closed shaynacohen closed 1 year ago

shaynacohen commented 1 year ago

Hey @NorberMV and @000paradox000 , this is my first time attempting to update the python-api docs. I'm not sure if it's as simple as submitting a PR, previewing the change, getting approved, and then merging to publish (the https://github.com/shotgunsoftware/developer.shotgunsoftware.com process). Can you let me know if I'm causing too much trouble? I can always assign the ticket to the Ecosystem team instead, and we can triage it. Thanks!

shaynacohen commented 1 year ago

Also including @julien-lang on this request. I'm not sure the process for previewing/publishing is, but I would love to incorporate this update since our intern made a great video about getting started with the Python API.

julien-lang commented 1 year ago

It is a good idea to integrate the video in the document. However, I am not sure its best place is in the Installation section. What about the Intro section instead? Before the example code: image

What do you think?

shaynacohen commented 1 year ago

Thanks @NorberMV and @julien-lang ! I'll dig into both of these...

shaynacohen commented 1 year ago

OK @NorberMV , how does this work with html? I'm also trying to add a note box and hyperlink on the installation page.

NorberMV commented 1 year ago

OK @NorberMV , how does this work with html? I'm also trying to add a note box and hyperlink on the installation page.

Screen Shot 2022-12-12 at 4 25 01 PM

Now it looks pretty good!

NorberMV commented 1 year ago
Screen Shot 2022-12-12 at 4 44 36 PM

Now the hyperlink is working !