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

Update onboarding #8504

Merged
merged 5 commits into from
Sep 20, 2021
Merged

Update onboarding #8504

merged 5 commits into from
Sep 20, 2021

Conversation

astrojuanlu
Copy link
Contributor

Addresses #8410 by

  1. Directing users to read the Read the Docs tutorial https://docs.readthedocs.io/page/tutorial/ rather than the Getting Started with Sphinx guide
  2. Replaces the demo (which was a dead end) by the same template used in the tutorial

This is how it looks like now:

Screenshot 2021-09-16 at 15-26-46 Project Dashboard Read the Docs

⚠️ Notice that https://github.com/readthedocs/tutorial-template/ doesn't exist yet, until we agree to transfer https://github.com/astrojuanlu/tutorial-template ⚠️

This also removes the demo code.

@astrojuanlu astrojuanlu requested a review from a team September 16, 2021 13:32
Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

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

This is much better UX! 💯

You may need to do a grep in other repositories (in particular -corporate) because there may be views that still depend on this class. Also, you will need to double check that the onboard_import.html file on -corporate does not require a change.

That said, I think we can't merge this PR without checking those things first.

@humitos
Copy link
Member

humitos commented Sep 16, 2021

Notice that readthedocs/tutorial-template doesn't exist yet, until we agree to transfer astrojuanlu/tutorial-template

+1 on transfering this

@astrojuanlu
Copy link
Contributor Author

astrojuanlu commented Sep 16, 2021

Good point, will check the corporate site now.

By the way, I don't understand the CircleCI failure 🤔 https://app.circleci.com/pipelines/github/readthedocs/readthedocs.org/2681/workflows/739e8fbc-0291-4bae-b3e9-8a308e633c54/jobs/5268?invite=true#step-105-354 (It's a Codecov problem, the real failure was in the tests)

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.

Yay deleting code :)

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

Migrated the tutorial template to our GitHub organization https://github.com/readthedocs/tutorial-template/ and replaced another two links on the homepage to point to the Tutorial. Merging!

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

3 participants