From 9cfd8b79753fca4528d259fee0b0115426779d64 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Wed, 5 Jul 2023 22:13:00 +0200 Subject: [PATCH] docs: add warning to authenticator docs, linking to official docs --- docs/howto/auth/awscognito.md | 12 ++++++++++++ docs/howto/auth/dummy.md | 2 ++ docs/howto/auth/firstuse.md | 12 ++++++++++++ docs/howto/auth/github.md | 12 ++++++++++++ docs/howto/auth/google.md | 12 ++++++++++++ docs/howto/auth/nativeauth.md | 12 ++++++++++++ 6 files changed, 62 insertions(+) diff --git a/docs/howto/auth/awscognito.md b/docs/howto/auth/awscognito.md index bf83116fa..382718931 100644 --- a/docs/howto/auth/awscognito.md +++ b/docs/howto/auth/awscognito.md @@ -2,6 +2,18 @@ # Authenticate using AWS Cognito +```{warning} +This documentation has not been updated recently, and a major version of +OAuthenticator has been released since it was. Due to that, please only use this +_as a complement_ to the official [OAuthenticator documentation]. + +[OAuthenticator documentation]: https://oauthenticator.readthedocs.io/en/latest/tutorials/provider-specific-setup/providers/generic.html#setup-for-aws-cognito + +Going onwards, the goal is to ensure we have good documentation in the +OAuthenticator project and reference that instead of maintaining similar +documentation in this project also. +``` + The **AWS Cognito Authenticator** lets users log into your JupyterHub using cognito user pools. To do so, you'll first need to register and configure a cognito user pool and app, and then provide information about this diff --git a/docs/howto/auth/dummy.md b/docs/howto/auth/dummy.md index b9ee2bc1f..99bc53084 100644 --- a/docs/howto/auth/dummy.md +++ b/docs/howto/auth/dummy.md @@ -2,9 +2,11 @@ # Authenticate _any_ user with a single shared password +```{warning} The **Dummy Authenticator** lets _any_ user log in with the given password. This authenticator is **extremely insecure**, so do not use it if you can avoid it. +``` ## Enabling the authenticator diff --git a/docs/howto/auth/firstuse.md b/docs/howto/auth/firstuse.md index edbf958ce..3bd05d4f7 100644 --- a/docs/howto/auth/firstuse.md +++ b/docs/howto/auth/firstuse.md @@ -2,6 +2,18 @@ # Let users choose a password when they first log in +```{warning} +This documentation is not being updated regularly and may be out of date. Due to +that, please only use this _as a complement_ to the official +[FirstUseAuthenticator documentation]. + +[FirstUseAuthenticator documentation]: https://github.com/jupyterhub/firstuseauthenticator#readme + +Going onwards, the goal is to ensure we have good documentation in the +FirstUseAuthenticator project and reference that instead of maintaining similar +documentation in this project also. +``` + The **First Use Authenticator** lets users choose their own password. Upon their first log-in attempt, whatever password they use will be stored as their password for subsequent log in attempts. This is diff --git a/docs/howto/auth/github.md b/docs/howto/auth/github.md index a1ce701be..47fed0ad1 100644 --- a/docs/howto/auth/github.md +++ b/docs/howto/auth/github.md @@ -2,6 +2,18 @@ # Authenticate using GitHub Usernames +```{warning} +This documentation has not been updated recently, and a major version of +OAuthenticator has been released since it was. Due to that, please only use this +_as a complement_ to the official [OAuthenticator documentation]. + +[OAuthenticator documentation]: https://oauthenticator.readthedocs.io/en/latest/tutorials/provider-specific-setup/providers/github.html + +Going onwards, the goal is to ensure we have good documentation in the +OAuthenticator project and reference that instead of maintaining similar +documentation in this project also. +``` + The **GitHub Authenticator** lets users log into your JupyterHub using their GitHub user ID / password. To do so, you'll first need to register an application with GitHub, and then provide information about this diff --git a/docs/howto/auth/google.md b/docs/howto/auth/google.md index bba1f0c14..2d74893ab 100644 --- a/docs/howto/auth/google.md +++ b/docs/howto/auth/google.md @@ -2,6 +2,18 @@ # Authenticate using Google +```{warning} +This documentation has not been updated recently, and a major version of +OAuthenticator has been released since it was. Due to that, please only use this +_as a complement_ to the official [OAuthenticator documentation]. + +[OAuthenticator documentation]: https://oauthenticator.readthedocs.io/en/latest/tutorials/provider-specific-setup/providers/google.html + +Going onwards, the goal is to ensure we have good documentation in the +OAuthenticator project and reference that instead of maintaining similar +documentation in this project also. +``` + The **Google OAuthenticator** lets users log into your JupyterHub using their Google user ID / password. To do so, you'll first need to register an application with Google, and then provide information about this diff --git a/docs/howto/auth/nativeauth.md b/docs/howto/auth/nativeauth.md index 92f3a0345..370e2e2ce 100644 --- a/docs/howto/auth/nativeauth.md +++ b/docs/howto/auth/nativeauth.md @@ -2,6 +2,18 @@ # Let users sign up with a username and password +```{warning} +This documentation is not being updated regularly and may be out of date. Due to +that, please only use this _as a complement_ to the official +[NativeAuthenticator documentation]. + +[NativeAuthenticator documentation]: https://native-authenticator.readthedocs.io/en/latest/ + +Going onwards, the goal is to ensure we have good documentation in the +NativeAuthenticator project and reference that instead of maintaining similar +documentation in this project also. +``` + The **Native Authenticator** lets users signup for creating a new username and password. When they signup, they won't be able to login until they are authorized by an