docs: add missing entries for provider specific docs

docs/source/conf.py

@@ -202,5 +202,7 @@ def render_autodoc_modules():
     "api/gen/oauthenticator.okpy": "reference/api/gen/oauthenticator.okpy",
     "api/gen/oauthenticator.openshift": "reference/api/gen/oauthenticator.openshift",
     "api/gen/oauthenticator.mediawiki": "reference/api/gen/oauthenticator.mediawiki",
+    # 2023-06-29 docs refresh
+    "topic/cilogon": "tutorials/provider-specific-setup/providers/cilogon",
     "tutorials/provider-specific-setup/providers/awscognito": "tutorials/provider-specific-setup/providers/generic",
 }

docs/source/tutorials/provider-specific-setup/index.md

@@ -14,22 +14,16 @@ can allow users part of specific GitHub organizations.
 :maxdepth: 1
 :caption: OAuth providers specific setup guides
 
+providers/auth0.md
 providers/azuread.md
+providers/bitbucket.md
+providers/cilogon.md
 providers/github.md
 providers/gitlab.md
 providers/globus.md
 providers/google.md
+providers/mediawiki.md
 providers/okpy.md
 providers/openshift.md
 providers/generic.md
 ```
-
-```{warning}
-The following authenticator classes doesn't yet have specialized documentation
-pages written for them.
-
-- `Auth0OAuthenticator`
-- `BitBucketOAuthenticator`
-- `CILogonOAuthenticator`
-- `MWOAuthenticator` (MW stands for MediaWiki)
-```

docs/source/tutorials/provider-specific-setup/providers/auth0.md

@@ -0,0 +1,24 @@
+# Auth0 Setup
+
+You need to have an Auth0 OAuth application registered ahead of time, see
+Auth0's official documentation about [registering an app].
+
+[registering an app]: https://auth0.com/docs/get-started/auth0-overview/create-applications/regular-web-apps
+
+## JupyterHub configuration
+
+Your `jupyterhub_config.py` file should look something like this:
+
+```python
+c.JupyterHub.authenticator_class = "auth0"
+c.OAuthenticator.oauth_callback_url = "https://[your-domain]/hub/oauth_callback"
+c.OAuthenticator.client_id = "[your oauth2 application id]"
+c.OAuthenticator.client_secret = "[your oauth2 application secret]"
+```
+
+## Additional required configuration
+
+Auth0OAuthenticator expands OAuthenticator with the following required config,
+read more about it in the configuration reference:
+
+- {attr}`.Auth0OAuthenticator.auth0_domain`

docs/source/tutorials/provider-specific-setup/providers/bitbucket.md

@@ -0,0 +1,24 @@
+# BitBucket Setup
+
+You need to have an BitBucket OAuth application registered ahead of time, see
+BitBucket's official documentation about [registering an app].
+
+[registering an app]: https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud/
+
+## JupyterHub configuration
+
+Your `jupyterhub_config.py` file should look something like this:
+
+```python
+c.JupyterHub.authenticator_class = "bitbucket"
+c.OAuthenticator.oauth_callback_url = "https://[your-domain]/hub/oauth_callback"
+c.OAuthenticator.client_id = "[your oauth2 application id]"
+c.OAuthenticator.client_secret = "[your oauth2 application secret]"
+```
+
+## Additional configuration
+
+BitBucketOAuthenticator expands OAuthenticator with the following config that may
+be relevant to read more about in the configuration reference:
+
+- {attr}`.BitBucketOAuthenticator.allowed_teams`

docs/source/tutorials/provider-specific-setup/providers/cilogon.md

@@ -0,0 +1,24 @@
+# CILogon Setup
+
+You need to have an CILogon OAuth application registered ahead of time, see
+CILogon's official documentation about [registering an app].
+
+[registering an app]: https://www.cilogon.org/oidc
+
+## JupyterHub configuration
+
+Your `jupyterhub_config.py` file should look something like this:
+
+```python
+c.JupyterHub.authenticator_class = "cilogon"
+c.OAuthenticator.oauth_callback_url = "https://[your-domain]/hub/oauth_callback"
+c.OAuthenticator.client_id = "[your oauth2 application id]"
+c.OAuthenticator.client_secret = "[your oauth2 application secret]"
+```
+
+## Additional required configuration
+
+CILogonOAuthenticator expands OAuthenticator with the following required config,
+read more about it in the configuration reference:
+
+- {attr}`.CILogonOAuthenticator.allowed_idps`

docs/source/tutorials/provider-specific-setup/providers/google.md

@@ -32,3 +32,9 @@ be relevant to read more about in the configuration reference:
 - {attr}`.GoogleOAuthenticator.allowed_google_groups`
 - {attr}`.GoogleOAuthenticator.admin_google_groups`
 - {attr}`.GoogleOAuthenticator.hosted_domain`
+
+If you configure `allowed_google_groups` or `admin_google_groups`, you are
+required to also configure:
+
+- {attr}`.GoogleOAuthenticator.gsuite_administrator`
+- {attr}`.GoogleOAuthenticator.google_service_account_keys`

docs/source/tutorials/provider-specific-setup/providers/mediawiki.md

@@ -0,0 +1,25 @@
+# MediaWiki Setup
+
+You need to have an MediaWiki OAuth application registered ahead of time, see
+MediaWiki's official documentation about [registering an app].
+
+[registering an app]: https://www.mediawiki.org/wiki/OAuth/For_Developers
+
+## JupyterHub configuration
+
+Your `jupyterhub_config.py` file should look something like this:
+
+```python
+c.JupyterHub.authenticator_class = "bitbucket"
+c.OAuthenticator.oauth_callback_url = "https://[your-domain]/hub/oauth_callback"
+c.OAuthenticator.client_id = "[your oauth2 application id]"
+c.OAuthenticator.client_secret = "[your oauth2 application secret]"
+```
+
+## Additional configuration
+
+MWOAuthenticator expands OAuthenticator with the following config that may
+be relevant to read more about in the configuration reference:
+
+- {attr}`.MWOAuthenticator.mw_index_url`
+- {attr}`.MWOAuthenticator.executor_threads`

oauthenticator/bitbucket.py

@@ -46,7 +46,7 @@ def _userdata_url_default(self):
     allowed_teams = Set(
         config=True,
         help="""
-        Automatically allow members of selected teams
+        Allow members of selected BitBucket teams to sign in.
         """,
     )