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

New Read the Docs tutorial, part III (and finale?) #8605

Merged
merged 12 commits into from
Oct 25, 2021

Conversation

astrojuanlu
Copy link
Contributor

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:

  1. Getting insights from your projects
    • Move around the project, explore results in Traffic Analytics
    • Play around with server-side search, explore results in Search Analytics
  2. Managing translations
  3. Where to go from here
    • Reference our existing guides, prominent projects already using RTD, domain configuration, our support form, our contributing documentation

I 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.

@astrojuanlu astrojuanlu requested a review from a team October 20, 2021 14:30
@astrojuanlu astrojuanlu requested a review from a team as a code owner October 20, 2021 14:30
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
Copy link
Member

@ericholscher ericholscher left a 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.

docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
@astrojuanlu
Copy link
Contributor Author

Thanks @ericholscher and @stsewd for the review, I addressed the comments.

@astrojuanlu astrojuanlu requested a review from a team October 20, 2021 22:15
@astrojuanlu
Copy link
Contributor Author

docs/tutorial/index.rst Outdated Show resolved Hide resolved
@Daltz333
Copy link

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.

@humitos
Copy link
Member

humitos commented Oct 25, 2021

We should probably update this part https://docs--8605.org.readthedocs.build/en/8605/tutorial/index.html#upgrading-the-python-version to use build.os and build.tools.python instead.

@humitos
Copy link
Member

humitos commented Oct 25, 2021

Unrelated to this PR, using :ref: to custom .. _references makes tooltips to be empty:

There is not too much that EmbedAPI can do because the id= that Sphinx generates has no content :/

This also helps sphinx-hoverxref generate a proper tooltip,
see #8605 (comment).
@astrojuanlu
Copy link
Contributor Author

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.

@astrojuanlu
Copy link
Contributor Author

Addressed all the feedback 👍🏽 Ready for another round

Copy link
Member

@ericholscher ericholscher left a 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.

docs/analytics.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved

Search Analytics
~~~~~~~~~~~~~~~~
Browsing Search Analytics
Copy link
Member

Choose a reason for hiding this comment

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

💯

docs/analytics.rst Outdated Show resolved Hide resolved
@ericholscher ericholscher merged commit e2fdefa into master Oct 25, 2021
@ericholscher ericholscher deleted the juanlu/rtd-tutorial-part-iii branch October 25, 2021 20:42
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.

None yet

5 participants