Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User profile doc #35

Merged
merged 3 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ nav:
- Help: user/manual/help.md
- Citation: user/manual/citation.md
- Source Reference: user/manual/source-reference-page.md
- User Profile: user/manual/user-profile.md
- Feedback Form: user/manual/feedback-form.md
- Administrators:
- administrator/index.md
- Biodiversity Data:
Expand Down
37 changes: 37 additions & 0 deletions docs/src/user/manual/feedback-form.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: BIMS Documentation
summary: Central documentation site for BIMS projects
- Tim Sutton
- Jeremy Prior
- Ketan Bamniya
date: 26-09-2023
some_url: https://github.com/kartoza/bims-website
copyright: Copyright 2023, Kartoza
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.
#context_id: 1234
---

# Feedback Form

> Note: Users are required to log in to submit the feedback form. While they can access the form without logging in, submission is restricted until they are logged in.

[![Home Page](./img/feedback-img-1.png)](./img/feedback-img-1.png)

1. **![Chat Icon](./img/feedback-img-2.png):** Click on this chat icon to open the feedback form.

[![Feedback Form](./img/feedback-img-3.png)](./img/feedback-img-3.png)

1. **x:** Click on the `x` to close the feedback form.

2. **Bug report:** Users must select the type of feedback they want to submit from the dropdown menu.

[![Dropdown Menu](./img/feedback-img-4.png)](./img/feedback-img-4.png)

3. **Summary:** The users are required to provide a brief summary of the feedback.

4. **Detailed description:** The users are required to provide a detailed description of the feedback.

5. **Github:** All issues are public and available through [Github](https://github.com/kartoza/django-bims/issues?q=is%3Aissue+is%3Aopen+label%3Auser-feedback).

6. **Submit:** After filling in all the necessary information, users can submit their feedback by clicking on the `Submit` button.
Binary file added docs/src/user/manual/img/feedback-img-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/feedback-img-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/feedback-img-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/feedback-img-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-12.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-13.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-14.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-15.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-17.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-18.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-19.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-20.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-21.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-22.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-23.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/user-profile-img-8.png
Binary file added docs/src/user/manual/img/user-profile-img-9.png
4 changes: 4 additions & 0 deletions docs/src/user/manual/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,7 @@ you may prefer to work through our [user guide](../guide/index.md).
**[Citation](./citation.md):** This provides a walkthrough of the citation page.

**[Source Reference](./source-reference-page.md):** This provides a walkthrough of the source reference page.

**[User Profile](./user-profile.md):** This provides a walkthrough of the user profile page.

**[Feedback Form](./feedback-form.md):** This provides a walkthrough of the feedback form.
170 changes: 170 additions & 0 deletions docs/src/user/manual/user-profile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
---
title: BIMS Documentation
summary: Central documentation site for BIMS projects
- Tim Sutton
- Jeremy Prior
- Ketan Bamniya
date: 26-09-2023
some_url: https://github.com/kartoza/bims-website
copyright: Copyright 2023, Kartoza
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.
#context_id: 1234
---

# User Profile

[![Home Page](./img/user-profile-img-1.png)](./img/user-profile-img-1.png)

1. **Username (Test):** Users can their profile by clicking on the username, this will open a drop down menu with options `Profile` and `Site Visits`.

[![Drop Down Menu](./img/user-profile-img-2.png)](./img/user-profile-img-2.png)

1 **Profile:** This will open the user profile page, where users can view their profile information, edit their profile and change their password.

2 **Site Visits:** This will open a page showing the user's site visit activities.

## Access Profile

[![Drop Down Menu Profile](./img/user-profile-img-3.png)](./img/user-profile-img-3.png)

1. **Profile:** This will open the user profile page, where users can view their profile information and edit it.

[![User Profile Page](./img/user-profile-img-4.png)](./img/user-profile-img-4.png)

1 **Username:** User name.

2 **Active:** User status.

3 **Organisation:** The organisation name to which the user belongs.

4 **Role:** Role of the user in their organisation.

5 **Email:** User email address.

6 **Edit Profile:** Users can edit their profile information.

7 **Set/Change Password:** Users can change their password.

8 **Overview:** The user profile overview provides detailed insights into their activity, including information about their contributions, the total number of site visits by the user, the total number of sites, and the total collection of records uploaded by the user.

[![Overview](./img/user-profile-img-5.png)](./img/user-profile-img-5.png)

9 **Site Visits:** This will open the `Site Visits` tab, where users can track activity on their sites, including details on how many users have visited their site.

[![Site Visits](./img/user-profile-img-6.png)](./img/user-profile-img-6.png)

10 **Source References:** This will open the `Source References` tab, allowing users to view all the source references they have uploaded. To upload source references click [here](./source-reference-page.md).

[![Source References](./img/user-profile-img-7.png)](./img/user-profile-img-7.png)

### Edit Profile

[![Edit Profile Form](./img/user-profile-img-8.png)](./img/user-profile-img-8.png)

1. **x:** Close the edit profile form.

2. **First Name:** User's first name.

3. **Last Name:** User's last name.

4. **Role:** User's role in their organisation. They can choose role from the dropdown menu.

[![Role Dropdown Menu](./img/user-profile-img-9.png)](./img/user-profile-img-9.png)

5. **Organisation:** Users can also update their organisation name.

6. **Update:** After filling in the updated details click on the `Update` button to update the profile.

* After completing the process here is the updated profile.

[![Updated profile](./img/user-profile-img-10.png)](./img/user-profile-img-10.png)

### Set/Change Password

[![Password Change Form](./img/user-profile-img-11.png)](./img/user-profile-img-11.png)

1. **Current Password:** The current password of the user.

2. **Rules For Password Creation:** These are the rules for creating a new password. User must follow these rules to create a new password otherwise it will show an error message.

[![Change Password Error Message](./img/user-profile-img-12.png)](./img/user-profile-img-12.png)

3. **New Password:** The new password of the user.

4. **New Password (again):** User must have to enter the new password again to confirm it.

5. **Change my password:** After filling in all the input fields click on the `Change my password` button to change the password. If the password is changed successfully it will show a success message.

[![Change Password Success Message](./img/user-profile-img-13.png)](./img/user-profile-img-13.png)

## Site Visits

[![Site Visits Page](./img/user-profile-img-14.png)](./img/user-profile-img-14.png)

1. **SITE VISIT:** Shows the number of users who have visited the site..

2. **See Unvalidated Data:** Users can view only the unvalidated data uploaded to the site by clicking the `See Unvalidated Data` button.

[![Unvalidated data](./img/user-profile-img-15.png)](./img/user-profile-img-15.png)

3. **Metrics:** Metrics contains the information about the site visits. It includes the number of visits, number of total sites, and the number records.

4. **Filters:** Users can arrange the data according to their preference by using the filters.

5. **Results:** Available data on the database.

## Filter

[![Filter](./img/user-profile-img-16.png)](./img/user-profile-img-16.png)

1. **Owner:** Users can filter data by the owner's name. To do so, they must type the owner's name in the search bar. The system will display a list of matching names, and it is mandatory to select a name from the list.

[![Owner Name Suggestions](./img/user-profile-img-17.png)](./img/user-profile-img-17.png)

2. **Site code:** Users can filter data by site code by entering the full site code or its leading characters into the input field and pressing the `enter` key.

3. **Module:** Users can also filter the data by the choosing the module from the dropdown list.

[![Module Names](./img/user-profile-img-18.png)](./img/user-profile-img-18.png)

* Users can also filter data by applying multiple filters simultaneously.

### Result Data

[![Result Data](./img/user-profile-img-19.png)](./img/user-profile-img-19.png)

1. **Arrange Order wise data:** User can arrange the data in ascending or descending order by clicking on the `up` and `down` arrow.

2. **Owner:** User can view the specific owner's activity by clicking on the owner's name.

[![Owner Activity](./img/user-profile-img-20.png)](./img/user-profile-img-20.png)

3. **Actions:** Users can [view](#site-view) the sites on the interactive map by clicking on the ![Eye Icon](./img/user-profile-img-21.png) icon.

[![View site](./img/user-profile-img-22.png)](./img/user-profile-img-22.png)

## Site View

[![Site View 1](./img/user-profile-img-23.png)](./img/user-profile-img-23.png)

1. **A1MMAP-00005:** The site code of the site.

2. **❎:** User can close the site view by clicking on the `❎` button.

3. **Zoom in and out:** Users can zoom in and out of the map by using the ➕ and ➖ buttons.

4. **Validated Public:** Indicating that this site is validated and available to the public.

5. **ℹ️:** Users can see the source information by clicking on this button.

6. **Longitude and Latitude:** These are the geographical coordinates of the site.

7. **Date:** The date when the site was uploaded.

8. **Owner:** The owner name of the site.

9. **Collector:** The name of the individual responsible for collecting data about the site.