Forgot password guide (#997)

* Forgot password guide * Update the YML and index file * Apply suggestions from code review Minor changes Co-authored-by: Jeremy-Prior <[email protected]> --------- Co-authored-by: Jeremy-Prior <[email protected]>
kartoza · Apr 23, 2024 · cfb12e1 · cfb12e1
1 parent 9e1683e
commit cfb12e1
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 0 deletions.
diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml
@@ -49,6 +49,7 @@ nav:
                   - Guide:
                         - user/guide/index.md
                         - Register-Login-Logout: user/guide/register-login-logout.md
+                        - Forgot Password: user/guide/forgot-password.md
                   - Manual:
                         - user/manual/index.md
                         - Landing Page: user/manual/landing-page.md

diff --git a/docs/src/user/guide/forgot-password.md b/docs/src/user/guide/forgot-password.md
@@ -0,0 +1,33 @@
+# miniSASS Forgot Password Page User Guide
+
+Welcome to the miniSASS Forgot Password Guide. In this guide, I'll walk you through the steps to reset your password if you've forgotten it.
+
+## How do I reset password
+
+Click on the 1️⃣ `click here` link, to go to the forgot password page.
+
+![login form](./img/forgot-password-1.png)
+
+Upon clicking on the link you will be redirected to the forgot password page where you need to enter your email address in the 1️⃣ email field in order to receive a reset password email. Once you entered your email click on the 2️⃣ `Send reset link` button to submit your forgot password request.
+
+![forgot password form](./img/forgot-password-2.png)
+
+On successful submission the success message will be displayed.
+
+![forgot password form](./img/forgot-password-3.png)
+
+Upon initiating the password reset process, you will receive an email containing a link to reset your password. You have three options to access the password update page:
+
+Within the email, there will be a 1️⃣ button labelled `Reset Password`. You can click on this button to be directed to the password update page. Alternatively, you can simply click on the 2️⃣ `Click Here` link provided in the email. This will also take you to the password update page. Or you can manually copy the provided link 3️⃣ from the email and paste it into your web browser's address bar. Press Enter to navigate to the password update page.
+
+![reset password email](./img/forgot-password-4.png)
+
+Upon clicking on any of three options you will be redirected to the update password page. Enter the new password into the 1️⃣ password fields and click on the 2️⃣ `Reset` button to reset the password.
+
+![update password form](./img/forgot-password-5.png)
+
+Upon successfully updating your password, you will receive a confirmation message indicating the update was successful. YOu can click on the `Go Back` button to go to the home page.
+
+![update password form](./img/forgot-password-6.png)
+
+Once you are back on the home page, you will find the login button. Click on the login button, and you will be directed to the login page where you can proceed to log in using your new password.
diff --git a/docs/src/user/guide/img/forgot-password-1.png b/docs/src/user/guide/img/forgot-password-1.png
diff --git a/docs/src/user/guide/img/forgot-password-2.png b/docs/src/user/guide/img/forgot-password-2.png
diff --git a/docs/src/user/guide/img/forgot-password-3.png b/docs/src/user/guide/img/forgot-password-3.png
diff --git a/docs/src/user/guide/img/forgot-password-4.png b/docs/src/user/guide/img/forgot-password-4.png
diff --git a/docs/src/user/guide/img/forgot-password-5.png b/docs/src/user/guide/img/forgot-password-5.png
diff --git a/docs/src/user/guide/img/forgot-password-6.png b/docs/src/user/guide/img/forgot-password-6.png
diff --git a/docs/src/user/guide/index.md b/docs/src/user/guide/index.md
@@ -3,3 +3,5 @@
 Welcome to the miniSASS user guide. In this section of the documentation, we aim to show users how to utilise the platform effectively, use maps and so forth. Here is a brief overview of the content provided here:
 
 * **[Registering/Login/Logout:](./register-login-logout.md)** This guide will walk you through the process of registering for an account, logging in, and logging out of miniSASS. Whether you're a new user looking to join our platform or a returning user ready to access your account, this guide has you covered. Let's get started!
+
+* **[Forgot Password:](./forgot-password.md)** This guide will walk you through the process of the forgot password functionality.