Registration doc (#77)

* Added github workflow * Added registration doc
kartoza · Nov 15, 2024 · 3d5abbe · 3d5abbe
1 parent 18bea7e
commit 3d5abbe
Show file tree

Hide file tree

Showing 24 changed files with 245 additions and 0 deletions.
diff --git a/docs/src/user/guide/signup-signin/img/guide-signin-img-1.png b/docs/src/user/guide/signup-signin/img/guide-signin-img-1.png
diff --git a/docs/src/user/guide/signup-signin/img/guide-signin-img-2.png b/docs/src/user/guide/signup-signin/img/guide-signin-img-2.png
diff --git a/docs/src/user/guide/signup-signin/img/guide-signin-img-3.png b/docs/src/user/guide/signup-signin/img/guide-signin-img-3.png
diff --git a/docs/src/user/guide/signup-signin/img/guide-signin-img-4.png b/docs/src/user/guide/signup-signin/img/guide-signin-img-4.png
diff --git a/docs/src/user/guide/signup-signin/img/guide-signin-img-5.png b/docs/src/user/guide/signup-signin/img/guide-signin-img-5.png
diff --git a/docs/src/user/guide/signup-signin/img/guide-signin-img-6.png b/docs/src/user/guide/signup-signin/img/guide-signin-img-6.png
diff --git a/docs/src/user/guide/signup-signin/img/guide-signup-img-1.png b/docs/src/user/guide/signup-signin/img/guide-signup-img-1.png
diff --git a/docs/src/user/guide/signup-signin/img/guide-signup-img-2.png b/docs/src/user/guide/signup-signin/img/guide-signup-img-2.png
diff --git a/docs/src/user/guide/signup-signin/img/guide-signup-img-3.png b/docs/src/user/guide/signup-signin/img/guide-signup-img-3.png
diff --git a/docs/src/user/guide/signup-signin/img/guide-signup-img-4.png b/docs/src/user/guide/signup-signin/img/guide-signup-img-4.png
diff --git a/docs/src/user/guide/signup-signin/img/guide-signup-img-5.png b/docs/src/user/guide/signup-signin/img/guide-signup-img-5.png
diff --git a/docs/src/user/guide/signup-signin/index.md b/docs/src/user/guide/signup-signin/index.md
@@ -0,0 +1,21 @@
+---
+title: PROJECT_TITLE
+summary: PROJECT_SUMMARY
+    - PERSON_1
+    - PERSON_2
+date: DATE
+some_url: PROJECT_GITHUB_URL
+copyright: Copyright 2023, PROJECT_OWNER
+contact: PROJECT_CONTACT
+license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
+--- 
+
+
+
+# SignUp-SignIn
+
+This section of documentation pertains to Signing up and Signing in on the Africa RangeLand Watch (ARW). It consists of:
+
+* **[Signup:](./sign-up.md)** This user guide will guide you through the signup process on ARW.
+
+* **[Signin:](./sign-in.md)** This user guide will guide you through the signin process on ARW.
diff --git a/docs/src/user/guide/signup-signin/sign-in.md b/docs/src/user/guide/signup-signin/sign-in.md
@@ -0,0 +1,55 @@
+---
+title: PROJECT_TITLE
+summary: PROJECT_SUMMARY
+    - PERSON_1
+    - PERSON_2
+date: DATE
+some_url: PROJECT_GITHUB_URL
+copyright: Copyright 2023, PROJECT_OWNER
+contact: PROJECT_CONTACT
+license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
+--- 
+
+# User Guide: Sign-In on Africa RangeLand Watch (ARW)
+
+## How to sign-in on the site.
+
+Follow these steps to sign-in on the site:
+
+Click on the 1️⃣ `Sign in` to open the sign-in form.
+
+[![ARW Home](./img/guide-signin-img-1.png)](./img/guide-signin-img-1.png)
+
+Here is the `Sign In` form.
+
+[![Sign in Form](./img/guide-signin-img-2.png)](./img/guide-signin-img-2.png)
+
+### There are two options are available for sign in:
+
+#### Option 1: Manually fill the details.
+
+Enter your `Email` and `Password` in the respective fields in the 1️⃣ `form` and then click on the 2️⃣ `Sign In` button to complete the process. 
+
+[![Sign in Form](./img/guide-signin-img-3.png)](./img/guide-signin-img-3.png)
+
+* **Remember me:** If you want to stay signed in on this device, check the `Remember me` box.
+
+#### Option 2: Use other accounts like google, github and apple to sign-in.
+
+User can also use 1️⃣ other accounts like google, github and apple to sign-in to the website.
+
+[![Sign in Other Accounts](./img/guide-signin-img-4.png)](./img/guide-signin-img-4.png)
+
+## Forgot Password
+
+### How to reset password:
+
+If you forgot your password, you can reset it by clicking on the 1️⃣ `forgot Password`.This will open a new form.
+
+[![Forgot Password](./img/guide-signin-img-5.png)](./img/guide-signin-img-5.png)
+
+Enter your registered email id in the 1️⃣ `input field` and then click on the 2️⃣ `Send Email` to reset the password.
+
+[![Forgot Password form](./img/guide-signin-img-6.png)](./img/guide-signin-img-6.png)
+
+* If you want to see how to create account please click [here](./sign-up.md).
diff --git a/docs/src/user/guide/signup-signin/sign-up.md b/docs/src/user/guide/signup-signin/sign-up.md
@@ -0,0 +1,47 @@
+---
+title: PROJECT_TITLE
+summary: PROJECT_SUMMARY
+    - PERSON_1
+    - PERSON_2
+date: DATE
+some_url: PROJECT_GITHUB_URL
+copyright: Copyright 2023, PROJECT_OWNER
+contact: PROJECT_CONTACT
+license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
+--- 
+
+# User Guide: Sign-Up on Africa RangeLand Watch (ARW)
+
+## How to sign-up on the site.
+
+Welcome to the `Africa RangeLand Watch!` Follow these steps to sign-up on the site:
+
+Click on the 1️⃣ `profile` or you can simply click on the 2️⃣ `sign-up`.
+
+[![Home page](./img/guide-signup-img-1.png)](./img/guide-signup-img-1.png)
+
+This will open a pop-up window. In this window click on the 1️⃣ `sign-up` button.
+
+[![Sign up button](./img/guide-signup-img-2.png)](./img/guide-signup-img-2.png)
+
+Here is the sign-up form.
+
+[![Sign up Form](./img/guide-signup-img-3.png)](./img/guide-signup-img-3.png)
+
+### There are two methods to sign-up on the site:
+
+#### Method 1: Manually fill the information in the form.
+
+[![Sign up Form](./img/guide-signup-img-4.png)](./img/guide-signup-img-4.png)
+
+- **Email:** Enter your valid email address.
+- **Password:** Enter your password.
+- **Confirm Password:** Re-enter your password to confirm.
+
+After filling the 1️⃣ `form` click on the 2️⃣ `sign-up` button.
+
+#### Method 2: Sign-up using other accounts like google, github and apple.
+
+[![Sign up Other Accounts](./img/guide-signup-img-5.png)](./img/guide-signup-img-5.png)
+
+* If you already have an account and you want to sign-in please click [here](./sign-in.md).
diff --git a/docs/src/user/manual/signup-signin/img/signin-img-1.png b/docs/src/user/manual/signup-signin/img/signin-img-1.png
diff --git a/docs/src/user/manual/signup-signin/img/signin-img-2.png b/docs/src/user/manual/signup-signin/img/signin-img-2.png
diff --git a/docs/src/user/manual/signup-signin/img/signin-img-3.png b/docs/src/user/manual/signup-signin/img/signin-img-3.png
diff --git a/docs/src/user/manual/signup-signin/img/signup-img-1.png b/docs/src/user/manual/signup-signin/img/signup-img-1.png
diff --git a/docs/src/user/manual/signup-signin/img/signup-img-2.png b/docs/src/user/manual/signup-signin/img/signup-img-2.png
diff --git a/docs/src/user/manual/signup-signin/img/signup-img-3.png b/docs/src/user/manual/signup-signin/img/signup-img-3.png
diff --git a/docs/src/user/manual/signup-signin/img/signup-img-4.png b/docs/src/user/manual/signup-signin/img/signup-img-4.png
diff --git a/docs/src/user/manual/signup-signin/index.md b/docs/src/user/manual/signup-signin/index.md
@@ -0,0 +1,21 @@
+---
+title: PROJECT_TITLE
+summary: PROJECT_SUMMARY
+    - PERSON_1
+    - PERSON_2
+date: DATE
+some_url: PROJECT_GITHUB_URL
+copyright: Copyright 2023, PROJECT_OWNER
+contact: PROJECT_CONTACT
+license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
+--- 
+
+
+# SignUp-SignIn
+
+This section of documentation pertains to Signing up and Signing in on the Africa RangeLand Watch (ARW). It consists of:
+
+* **[Signup:](./sign-up.md)** This user manual will guide you through the signup process on ARW.
+
+* **[Signin:](./sign-in.md)** This user manual will guide you through the signin process on ARW.
+
diff --git a/docs/src/user/manual/signup-signin/sign-in.md b/docs/src/user/manual/signup-signin/sign-in.md
@@ -0,0 +1,50 @@
+---
+title: PROJECT_TITLE
+summary: PROJECT_SUMMARY
+    - PERSON_1
+    - PERSON_2
+date: DATE
+some_url: PROJECT_GITHUB_URL
+copyright: Copyright 2023, PROJECT_OWNER
+contact: PROJECT_CONTACT
+license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
+--- 
+
+# User Manual: Sign-In on Africa RangeLand Watch (ARW)
+
+Welcome to the ARW sign-in user manual. This guide provides step-by-step instructions on how to sign in to the ARW website.
+
+[![ARW Home Page](./img/signin-img-1.png)](./img/signin-img-1.png)
+
+1. **Sign In:** Click on the `Sign In` button to go to the sign-in page.
+
+[![ARW Signin Page](./img/signin-img-2.png)](./img/signin-img-2.png)
+
+1. **Form Fields:** Fill the following information in the form to complete the sign-in process.
+
+    - **Email:** Enter your registered email address.
+    - **Password:** Enter the password you created during the sign-up process.
+
+2. **Remember me:** If you want to stay signed in on this device, check the `Remember me` box.
+
+3. **Forgot Password:** In case you forgot your password, click on the `Forgot Password` link to reset it. This will open a new form.
+
+    [![Form Password](./img/signin-img-3.png)](./img/signin-img-3.png)
+
+    **1. Email:** Enter the email address associated with your account.
+
+    **2. Send Email:** Click on the `Send Email` button to receive a password reset email.
+
+    **3. Back to Sign In:** Click on the `Back to Sign In` button to return to the sign-in page.    
+
+    **4. x:** Click on the `x` button to close the password reset form.
+
+4. **Sign In:** Click on the `Sign In` button to complete the sign-in process.
+
+5. **Other Accounts:** You can also sign in using your other accounts like  accounts.
+
+6. **Sign Up:** If you don't have an account, click on the `Sign Up` button to create one.
+
+7. **x:** Click on the `x` button to close the sign-in form.
+
+* To see how to create an account click on the [Sign-up](./sign-up.md)
diff --git a/docs/src/user/manual/signup-signin/sign-up.md b/docs/src/user/manual/signup-signin/sign-up.md
@@ -0,0 +1,51 @@
+---
+title: PROJECT_TITLE
+summary: PROJECT_SUMMARY
+    - PERSON_1
+    - PERSON_2
+date: DATE
+some_url: PROJECT_GITHUB_URL
+copyright: Copyright 2023, PROJECT_OWNER
+contact: PROJECT_CONTACT
+license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
+--- 
+
+# User Manual: Sign-Up on Africa RangeLand Watch (ARW)
+
+## Introduction 
+
+The ARW allows user to create account and sign up for the platform. This user manual will guide you through the process of signing up on ARW. 
+
+## Accessing the Signup page
+
+[![ARW Home Page](./img/signup-img-1.png)](./img/signup-img-1.png)
+
+1. Click on the `Profile icon` in the top right corner to access the sign-up form.
+
+2. **Sign In:** You can also click on the `Sign in` to access the sign-up page.
+
+[![Sign in page](./img/signup-img-3.png)](./img/signup-img-3.png)
+
+1. **Sign Up:** Click on the `Sign up` button to access the sign-up form.
+
+## Sign Up with the new account 
+
+[![Sign-up Page](./img/signup-img-4.png)](./img/signup-img-4.png)
+
+Here are two options to sign up for a new account:
+
+1. **Form field:** ARW sign-up form allows user to create a new account by entering the necessary information.
+
+    - **Email:** Enter the email address you want to use for your ARW account.
+    - **Password:** Enter a strong password for your ARW account.
+    - **Confirm Password:** Re-enter the password to confirm it.
+
+2. **Sign-Up:** Click the `Sign Up` button to complete the sign-up process. A verification email will be sent to the address you provided.
+
+3. **Other Accounts:** User can also use other accounts like google, github and apple to sign-up.
+
+4. **Back to Sign In:** Click on the `Back to Sign In` button to go back to the sign-in page.
+
+5. **x:** By clicking on this button you can close the form.
+
+- Click on the [signing](./sign-in.md) to see the signing process.