-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
New Read the Docs tutorial, part III (and finale?) #8605
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good! I think the only key changes are what Santos mentioned.
I'd also love to find ways to interlink the tutorial content with out feature pages. It feels like some of this content would be useful on the pages around the various analytics features.
Thanks @ericholscher and @stsewd for the review, I addressed the comments. |
Rendered version: https://docs--8605.org.readthedocs.build/en/8605/tutorial/index.html |
In regards to translations, frc-docs has developed a pretty decent workflow at https://github.com/wpilibsuite/frc-docs-translations These translations are fully automatic and us maintainers require no work. |
We should probably update this part https://docs--8605.org.readthedocs.build/en/8605/tutorial/index.html#upgrading-the-python-version to use |
Unrelated to this PR, using
There is not too much that EmbedAPI can do because the |
This also helps sphinx-hoverxref generate a proper tooltip, see #8605 (comment).
Thanks @Daltz333! I think we should have a closer look at your procedure. We have several scattered conversations about translations here (#810, #4462, #4463) and we have been talking internally about revamping our workflow. I left a comment in the last one to keep track of your suggestion, although we will leave translations out of the tutorial for now. |
Addressed all the feedback 👍🏽 Ready for another round |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me with a couple nitpicks. I'd love to get it shipped today, so I might merge my suggestions & the PR to get it out.
|
||
Search Analytics | ||
~~~~~~~~~~~~~~~~ | ||
Browsing Search Analytics |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💯
This is the third (and last? at least for now) pull request for the new Read the Docs tutorial proposed in #8106 in the context of the CZI grant. It is a follow up to #8428 and #8473.
This pull request intends to cover these chapters of the table of contents originally proposed in #8106:
Managing translationsI skipped the Translations part since we are ourselves figuring out what the best workflow could be, among all the possible options. We should probably refresh our translations guide instead.