Merge pull request #8504 from readthedocs/juanlu/update-onboarding

Update onboarding

Author: astrojuanlu

docs/tutorial/index.rst

@@ -24,7 +24,7 @@ Preparing your project on GitHub
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To start, `sign in to GitHub <https://github.com/login>`_
-and navigate to `the tutorial GitHub template <https://github.com/astrojuanlu/tutorial-template/>`_,
+and navigate to `the tutorial GitHub template <https://github.com/readthedocs/tutorial-template/>`_,
 where you will see a green :guilabel:`Use this template` button.
 Click it to open a new page that will ask you for some details:
 

readthedocs/projects/backends/views.py

@@ -15,9 +15,3 @@
 class ImportWizardView(SettingsOverrideObject):
     _default_class = private.ImportWizardView
     _override_setting = 'PROJECT_IMPORT_VIEW'
-
-
-# Project demo import
-class ImportDemoView(SettingsOverrideObject):
-    _default_class = private.ImportDemoView
-    _override_setting = 'PROJECT_IMPORT_DEMO_VIEW'

readthedocs/projects/urls/private.py

@@ -6,7 +6,7 @@
 from django.views.generic.base import RedirectView
 
 from readthedocs.constants import pattern_opts
-from readthedocs.projects.backends.views import ImportDemoView, ImportWizardView
+from readthedocs.projects.backends.views import ImportWizardView
 from readthedocs.projects.views import private
 from readthedocs.projects.views.private import (
     AutomationRuleDelete,
@@ -58,10 +58,6 @@
         r'^import/manual/$', ImportWizardView.as_view(),
         name='projects_import_manual',
     ),
-    url(
-        r'^import/manual/demo/$', ImportDemoView.as_view(),
-        name='projects_import_demo',
-    ),
     url(
         r'^(?P<project_slug>[-\w]+)/$',
         login_required(

readthedocs/projects/views/private.py

@@ -343,72 +343,6 @@ def is_advanced(self):
         return data.get('advanced', True)
 
 
-class ImportDemoView(PrivateViewMixin, ProjectImportMixin, View):
-
-    """View to pass request on to import form to import demo project."""
-
-    form_class = ProjectBasicsForm
-    request = None
-    args = None
-    kwargs = None
-
-    def get(self, request, *args, **kwargs):
-        """Process link request as a form post to the project import form."""
-        self.request = request
-        self.args = args
-        self.kwargs = kwargs
-
-        data = self.get_form_data()
-        project = Project.objects.for_admin_user(
-            request.user,
-        ).filter(repo=data['repo']).first()
-        if project is not None:
-            messages.success(
-                request,
-                _('The demo project is already imported!'),
-            )
-        else:
-            kwargs = self.get_form_kwargs()
-            form = self.form_class(data=data, **kwargs)
-            if form.is_valid():
-                project = form.save()
-                project.save()
-                self.trigger_initial_build(project, request.user)
-                messages.success(
-                    request,
-                    _('Your demo project is currently being imported'),
-                )
-            else:
-                messages.error(
-                    request,
-                    _('There was a problem adding the demo project'),
-                )
-                return HttpResponseRedirect(reverse('projects_dashboard'))
-        return HttpResponseRedirect(
-            reverse('projects_detail', args=[project.slug]),
-        )
-
-    def get_form_data(self):
-        """Get form data to post to import form."""
-        return {
-            'name': '{}-demo'.format(self.request.user.username),
-            'repo_type': 'git',
-            'repo': 'https://github.com/readthedocs/template.git',
-        }
-
-    def get_form_kwargs(self):
-        """Form kwargs passed in during instantiation."""
-        return {'user': self.request.user}
-
-    def trigger_initial_build(self, project, user):
-        """
-        Trigger initial build.
-
-        Allow to override the behavior from outside.
-        """
-        return trigger_build(project)
-
-
 class ImportView(PrivateViewMixin, TemplateView):
 
     """

readthedocs/rtd_tests/tests/test_project_views.py

@@ -346,120 +346,6 @@ def test_form_spam_ban_user(self, mocked_validator):
         self.assertTrue(self.user.profile.banned)
 
 
-@mock.patch('readthedocs.projects.views.private.trigger_build', mock.MagicMock())
-class TestImportDemoView(TestCase):
-    """Test project import demo view."""
-
-    fixtures = ['test_data', 'eric']
-
-    def setUp(self):
-        self.client.login(username='eric', password='test')
-
-    def test_import_demo_pass(self):
-        resp = self.client.get('/dashboard/import/manual/demo/')
-        self.assertEqual(resp.status_code, 302)
-        self.assertEqual(resp['Location'], '/projects/eric-demo/')
-        resp_redir = self.client.get(resp['Location'])
-        self.assertEqual(resp_redir.status_code, 200)
-        messages = list(resp_redir.context['messages'])
-        self.assertEqual(messages[0].level, message_const.SUCCESS)
-
-    def test_import_demo_already_imported(self):
-        """Import demo project multiple times, expect failure 2nd post."""
-        self.test_import_demo_pass()
-        project = Project.objects.get(slug='eric-demo')
-
-        resp = self.client.get('/dashboard/import/manual/demo/')
-        self.assertEqual(resp.status_code, 302)
-        self.assertEqual(resp['Location'], '/projects/eric-demo/')
-
-        resp_redir = self.client.get(resp['Location'])
-        self.assertEqual(resp_redir.status_code, 200)
-        messages = list(resp_redir.context['messages'])
-        self.assertEqual(messages[0].level, message_const.SUCCESS)
-
-        self.assertEqual(
-            project,
-            Project.objects.get(slug='eric-demo'),
-        )
-
-    def test_import_demo_another_user_imported(self):
-        """Import demo project after another user, expect success."""
-        self.test_import_demo_pass()
-        project = Project.objects.get(slug='eric-demo')
-
-        self.client.logout()
-        self.client.login(username='test', password='test')
-        resp = self.client.get('/dashboard/import/manual/demo/')
-        self.assertEqual(resp.status_code, 302)
-        self.assertEqual(resp['Location'], '/projects/test-demo/')
-
-        resp_redir = self.client.get(resp['Location'])
-        self.assertEqual(resp_redir.status_code, 200)
-        messages = list(resp_redir.context['messages'])
-        self.assertEqual(messages[0].level, message_const.SUCCESS)
-
-    def test_import_demo_imported_renamed(self):
-        """If the demo project is renamed, don't import another."""
-        self.test_import_demo_pass()
-        project = Project.objects.get(slug='eric-demo')
-        project.name = 'eric-demo-foobar'
-        project.save()
-
-        resp = self.client.get('/dashboard/import/manual/demo/')
-        self.assertEqual(resp.status_code, 302)
-        self.assertEqual(resp['Location'], '/projects/eric-demo/')
-
-        resp_redir = self.client.get(resp['Location'])
-        self.assertEqual(resp_redir.status_code, 200)
-        messages = list(resp_redir.context['messages'])
-        self.assertEqual(messages[0].level, message_const.SUCCESS)
-        self.assertRegex(
-            messages[0].message,
-            r'already imported',
-        )
-
-        self.assertEqual(
-            project,
-            Project.objects.get(slug='eric-demo'),
-        )
-
-    def test_import_demo_imported_duplicate(self):
-        """
-        If a project exists with same name, expect a failure importing demo.
-
-        This should be edge case, user would have to import a project (not the
-        demo project), named user-demo, and then manually enter the demo import
-        URL, as the onboarding isn't shown when projects > 0
-        """
-        self.test_import_demo_pass()
-        project = Project.objects.get(slug='eric-demo')
-        project.repo = 'file:///foobar'
-        project.save()
-
-        # Setting the primary and verified email of the test user.
-        user = User.objects.get(username='eric')
-        user_email = get(EmailAddress, user=user, primary=True, verified=True)
-
-        resp = self.client.get('/dashboard/import/manual/demo/')
-        self.assertEqual(resp.status_code, 302)
-        self.assertEqual(resp['Location'], '/dashboard/')
-
-        resp_redir = self.client.get(resp['Location'])
-        self.assertEqual(resp_redir.status_code, 200)
-        messages = list(resp_redir.context['messages'])
-        self.assertEqual(messages[0].level, message_const.ERROR)
-        self.assertRegex(
-            messages[0].message,
-            r'There was a problem',
-        )
-
-        self.assertEqual(
-            project,
-            Project.objects.get(slug='eric-demo'),
-        )
-
-
 @mock.patch('readthedocs.core.utils.trigger_build', mock.MagicMock())
 class TestPublicViews(TestCase):
     def setUp(self):

readthedocs/rtd_tests/tests/test_views.py

@@ -83,10 +83,6 @@ def test_import_wizard_manual(self):
         response = self.client.get('/dashboard/import/manual/')
         self.assertRedirectToLogin(response)
 
-    def test_import_wizard_demo(self):
-        response = self.client.get('/dashboard/import/manual/demo/')
-        self.assertRedirectToLogin(response)
-
     def test_edit(self):
         response = self.client.get('/dashboard/pip/edit/')
         self.assertRedirectToLogin(response)

readthedocs/templates/base.html

@@ -168,7 +168,7 @@ <h4>{% trans 'Resources' %}</h4>
 
           <ul>
             <li>
-              <a href="https://docs.readthedocs.io/page/intro/getting-started-with-sphinx.html">{% trans 'Getting Started Guide' %}</a>
+              <a href="https://docs.readthedocs.io/page/tutorial/">{% trans 'Tutorial' %}</a>
             </li>
             <li>
               <a href="https://docs.readthedocs.io/page/team.html">{% trans 'Team' %}</a>

readthedocs/templates/homepage.html

@@ -106,7 +106,7 @@ <h3>Multiple versions</h3>
   <!-- Call to action -->
   <section>
     <p style="text-align: center">
-      <a href="https://docs.readthedocs.io/page/intro/getting-started-with-sphinx.html" class="cta-btn">{% trans 'Getting started guide' %}</a>
+      <a href="https://docs.readthedocs.io/page/tutorial/" class="cta-btn">{% trans 'Read the Tutorial' %}</a>
     </p>
   </section>
 

readthedocs/templates/projects/onboard_import.html

@@ -4,20 +4,21 @@
 <div class="onboard onboard-import-project">
   <h2>{% trans "Ready to share your documentation" %}{% if request.user.first_name %}, {{ request.user.first_name }}{% endif %}?</h2>
 
-  {% with getting_started_url="https://docs.readthedocs.io/page/intro/getting-started-with-sphinx.html" %}
+  {% with tutorial_url="https://docs.readthedocs.io/page/tutorial/" template_project_url="https://github.com/readthedocs/tutorial-template/" %}
     <form method="get" action="{% url "projects_import" %}">
       <p>
         {% blocktrans trimmed %}
           You don't have any projects yet, but you can start building documentation by importing one.
           Not sure how to start documenting your project?
-          Check out the <a href="{{ getting_started_url }}">Getting Started Guide</a> to learn how.
+          Check out the <a href="{{ tutorial_url }}">Tutorial</a> to learn how.
         {% endblocktrans %}
       </p>
 
       <p>
-        {% url "projects_import_demo" as import_demo_url %}
+        {% url "projects_import" as projects_import_url %}
         {% blocktrans trimmed %}
-          Want to try a demo? <a href="{{ import_demo_url }}">Import our own demo project</a>.
+          In a hurry? <a href="{{ template_project_url }}">Fork our template project</a> on Github,
+          and <a href="{{ projects_import_url }}">import it</a>.
         {% endblocktrans %}
       </p>