Organizations: show the slug field on creation (#12297)

Required by readthedocs/ext-theme#25

Author: humitos

readthedocs/organizations/forms.py

@@ -92,14 +92,23 @@ class OrganizationSignupFormBase(OrganizationForm):
 
     class Meta:
         model = Organization
-        fields = ["name", "email"]
+        fields = ["name", "slug", "email"]
         labels = {
             "name": _("Organization Name"),
             "email": _("Billing Email"),
         }
+        help_texts = {
+            "slug": "Used in URLs for your projects when not using a custom domain. It cannot be changed later.",
+        }
 
     url = None
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        # `slug` is not required since its value is auto-generated from `name` if not provided
+        self.fields["slug"].required = False
+
     @staticmethod
     def _create_default_teams(organization):
         organization.teams.create(name="Admins", access=ADMIN_ACCESS)

readthedocs/organizations/tests/test_forms.py

@@ -179,3 +179,15 @@ def test_create_organization_with_nonexistent_slug(self):
         }
         form = forms.OrganizationSignupForm(data, user=self.user)
         self.assertTrue(form.is_valid())
+        organization = form.save()
+        self.assertEqual(Organization.objects.filter(slug="my-new-organization").count(), 1)
+
+    def test_create_organization_with_invalid_slug(self):
+        data = {
+            "name": "My Org",
+            "email": "[email protected]",
+            "slug": "invalid-<slug>",
+        }
+        form = forms.OrganizationSignupForm(data, user=self.user)
+        self.assertFalse(form.is_valid())
+        self.assertIn("consisting of letters, numbers", form.errors["slug"][0])