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

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

Merged
merged 5 commits into from
Dec 12, 2022

Conversation

shaynacohen
Copy link
Contributor

No description provided.

@shaynacohen
Copy link
Contributor Author

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
Copy link
Contributor Author

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.

Copy link
Contributor

@000paradox000 000paradox000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@julien-lang
Copy link
Contributor

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?

Copy link
Contributor

@NorberMV NorberMV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screen Shot 2022-12-12 at 3 29 07 PM

Hi Shayna, I just generated a preview with your changes, but only the url of the video is visible, this documentation is generated using sphinx, not sure if maybe the way of embedding a video is different here.

@shaynacohen
Copy link
Contributor Author

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

@shaynacohen
Copy link
Contributor Author

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

@NorberMV
Copy link
Contributor

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
Copy link
Contributor

Screen Shot 2022-12-12 at 4 44 36 PM

Now the hyperlink is working !

@NorberMV NorberMV self-requested a review December 12, 2022 21:48
Copy link
Contributor

@NorberMV NorberMV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The preview looks good now!

@shaynacohen shaynacohen merged commit d33cda1 into master Dec 12, 2022
@shaynacohen shaynacohen deleted the duguids-SG-29350-add-video-to-installation-docs branch December 12, 2022 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants