Skip to content

Commit

Permalink
Merge pull request #4 from WBG-Coach/edits
Browse files Browse the repository at this point in the history
initial fixes to text
  • Loading branch information
educationfutures authored Jan 15, 2024
2 parents 7869f64 + bd5063c commit 4f3be7c
Show file tree
Hide file tree
Showing 20 changed files with 410 additions and 445 deletions.
14 changes: 7 additions & 7 deletions docs/admin/accessing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@
sidebar_position: 0
---

# About the application
# About the Application

The Admin Panel is the system used by the government and people responsible for managing data and information on the Coach Digital app. It is possible:
The Admin Panel serves as a vital tool for government officials and designated individuals in managing data and information within the Coach Digital app. It offers the following capabilities:

- View data from sessions that Coaches held with teachers
- View local, regional and national performance data*
- Create and edit Teaching Practices used by Coaches to evaluate teachers in the coaching process
- Viewing data from sessions conducted by Coaches with teachers.
- Accessing performance data at local, regional, and national levels*.
- Creating and editing Teaching Practices that Coaches use to assess teachers during the coaching process.

**Data region preview availability depends on user permission.*
*Note: The availability of data previews for different regions is subject to user permissions.*

## Getting Started

To start using, access the [Admin Panel](https://coachdigital.org/np/admin/) website and enter your registered username and password.
To begin utilizing the Admin Panel, visit the [Admin Panel website](https://coachdigital.org/np/admin/) and sign in using your registered username and password.

![Login page](/img/admin_getting_started/admin-login.png)

36 changes: 18 additions & 18 deletions docs/admin/basic-usage/navigating.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,41 @@
sidebar_position: 0
---

# Sidebar
# Sidebar Navigation

Navigation in the Admin Panel is done through the sidebar. It is possible to access different types of application resources, such as settings, dashboard and data tables.
The sidebar in the Admin Panel is your gateway to navigating the application. It provides access to a variety of resources, including settings, dashboard, and data tables.

![Sidebar](/img/admin_getting_started/admin-sidebar.png)

## User resources
## User Resources

In the side menu, the card containing user information provides access to settings and logout.
Within the sidebar, you'll find a user information card. This card offers quick access to settings and the logout option.

![User resources](/img/admin_getting_started/user-card.png)

### Settings

Settings have **account and system-related** functionality.
The Settings section encompasses both account and system-related functionalities.

Account-related resources:
Account-related options include:

- Change or add a photo
- Change email address
- Change name and password.
- Updating or adding a profile photo.
- Changing the email address.
- Modifying your name and password.

System-related resources:
System-related options include:

- Change the language
- Manage regions and other users\*
- Switching the application's language.
- Managing regions and other user accounts.*

\*_Feature available only for users with higher permission levels._
\*_Note: User management features are only accessible to users with higher permission levels._

![Settings](/img/admin_getting_started/admin-settings.png)

## Sidebar's divisions
## Divisions of the Sidebar

The admin panel is divided into 3 areas:
The Admin Panel is structured into three main areas:

- **Dashboard:** It is the main screen of the application, which displays information about the performance of the chosen region over a period determined by the user.
- **Questionnaire:** In this area you can access sections that contain information and resources related to the questionnaire used by Coaches during the Classroom Observation process.
- **Data:** This area has sections that contain tables with raw data that can be filtered, exported or viewed in more detail.
- **Dashboard:** The primary interface of the application, displaying performance data and analytics for a selected region over a user-defined time period.
- **Questionnaire:** This section offers access to information and tools related to the questionnaire used in the Classroom Observation process by Coaches.
- **Data:** Comprising sections that present raw data in tabular form, this area allows for filtering, exporting, and in-depth examination of data.
18 changes: 9 additions & 9 deletions docs/admin/sidebar-items/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,32 @@ sidebar_position: 0

# Dashboard

The dashboard contains general data about a region over a specified period of time.
The Dashboard provides an overview of regional data over a specified time frame.

## Filters

The dashboard has filters that can be applied to select more specific information about regions, districts and municipalities, in addition, there is the possibility of determining the period for which you want to obtain the data.
To tailor the data, the Dashboard includes filters for selecting specific regions, districts, and municipalities. Additionally, users can define the time period for which they wish to retrieve data.

![Dashboard filters](/img/admin_getting_started/admin-dashboard-filters.png)

## Data sections
## Data Sections

It is possible to view data about: Engagement, Targeted improvement areas, Specific data for each Teaching Practice.
The Dashboard allows viewing data on Engagement, Targeted Improvement Areas, and Specific Data for each Teaching Practice.

### Engagement

The engagement data points out information about coaches and teachers activities for the chosen region in the given time.
This section offers insights into the activities of coaches and teachers in the selected region for the specified time period.

![Engagement section](/img/admin_getting_started/admin-dashboard-engagement.png)

### Targeted improvement areas
### Targeted Improvement Areas

The targeted improvement areas are the Teaching Practices chosen to be worked on with teachers. This information highlights which teaching practices teachers face the most difficulty in being better.
This area focuses on the Teaching Practices identified for enhancement with teachers. It highlights the practices where teachers most commonly struggle and need improvement.

![Targeted improvement areas](/img/admin_getting_started/admin-dashbord-targeted.png)

### Specific data for each Teaching Practice
### Specific Data for Each Teaching Practice

Below the targeted improment areas graph it is possible to select a Teaching Practice to view more about it. This section presents a more granular overview of how teachers are performing in the region in the time interval chosen for each Teaching Practice.
Located below the Targeted Improvement Areas graph, this feature allows users to select a Teaching Practice to examine in more detail. It provides a granular view of teacher performance in the chosen region and time interval for each specific Teaching Practice.

![Targeted improvement areas](/img/admin_getting_started/admin-dashboard-specific.png)
105 changes: 44 additions & 61 deletions docs/admin/sidebar-items/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,112 +4,95 @@ sidebar_position: 2

# Data

The data area contains more dense information about schools and sessions performed with the teacher. They are divided into the **Schools**, **Coaching activity** and **Sync log** pages.
The Data section provides detailed information about schools and coaching sessions with teachers. It is organized into **Schools**, **Coaching Activity**, and **Sync Log** sections.

## Schools

This page contains the main features for managing Schools.
This section is dedicated to managing school-related data. Features include:

In this page is possible to:

- Add new schools
- Download the page's data
- Import data from a database
- Generate school's QR code
- Edit an existing school
- Delete a school
- Adding new schools.
- Downloading data from the current page.
- Importing data from a database.
- Generating a QR code for a school.
- Editing existing school details.
- Deleting a school.

![Teaching Practices page](/img/admin_getting_started/schools-page.png)

### Downloading page's data & Importing data

The "import data" button allows you to select a CSV file from the computer.
### Downloading and Importing Data

The "Download data" button starts a download of a XLSX file to the computer.
- **Import Data**: Use the "Import Data" button to upload a CSV file from your computer.
- **Download Data**: Click the "Download Data" button to initiate the download of an XLSX file.

To use these functionalities, use the buttons at the top right of the screen.
These options are accessible via buttons located at the top right of the screen.

![Schools page's button](/img/admin_getting_started/schools-buttons.png)

### Add new school

To add a new school, tap the "New school" button at the top right of the screen.
### Adding a New School

The button will open a drawer, where it is possible to add the name of the school, its EMIS number and region.
Click the "New School" button at the top right of the screen to add a new school. A form will appear where you can enter the school's name, EMIS number, and region.

![New Teaching Practice](/img/admin_getting_started/add-school.png)

### Actions in schools
### Managing Schools

The three-dot-button in each row of the table opens a menu of actions available of the school.
Each school entry has a three-dot-button that reveals available actions for that school.

![School's actions](/img/admin_getting_started/schools-actions.png)

The actions have the following functionalities:
#### Generate QR Code

#### Generate QR code

Opens a screen that shows the QR code of the school.
The QR code is used by Coaches to setup their device with the school's data, this screen shoud be printed and displayed at schools so Coaches can setup the app.
Generates a QR code for the school, useful for Coaches to quickly set up their devices with the school's data. The QR code should be printed and made available for use at the school.

![QR code screen](/img/admin_getting_started/schools-qr-code.png)

#### Edit
#### Edit School Details

Opens a drawer that allows the user to change the school's name, EMIS and regions.
Allows editing of the school's name, EMIS number, and region.

![Editing a school](/img/admin_getting_started/schools-edit.png)

#### Delete
#### Delete School

Opens a modal confirming the action. Once deleted the school is removed from the list.
Initiates a confirmation modal. Once confirmed, the school is permanently removed.

:::danger Irreversible action

Be careful, this action is permanent and irreversible.

This is a permanent and irreversible action.
:::

![Deleting a school](/img/admin_getting_started/schools-delete.png)

## Coaching Activity

## Coaching activity

The coaching activity page presents a table of coaching sessions performed in each school.

The table contains:
This page displays a table summarizing coaching sessions at each school, including:

- School name
- Number of coaches in the school
- Number of teachers that were coached
- Number of feedback sessions
- The distribution of coaching sessions in a range of: 0-30, 30-60, 60-90, 90+ days
- School name.
- Number of coaches.
- Number of teachers coached.
- Number of feedback sessions.
- Distribution of coaching sessions across time ranges: 0-30, 30-60, 60-90, 90+ days.

![Coaching sessions page](/img/admin_getting_started/coaching-activity-page.png)

## Sessions data
## Sessions Data

The sessions data page presents a table of feedback sessions performed in each school.
This page offers a detailed view of feedback sessions at each school, featuring:

The table contains:

- School name
- Number of coaches in the school
- Number of teachers that were coached
- Number of feedback sessions
- The average rating of each Teaching Practice in the school
- School name.
- Number of coaches.
- Number of teachers coached.
- Number of feedback sessions.
- Average rating of each Teaching Practice at the school.

![Coaching sessions page](/img/admin_getting_started/sessions-data-page.png)

## Sync log

The sync log page presents a table with information about the synchronization of the devices.
## Sync Log

The table contains:
The Sync Log page provides details about device synchronization, including:

- Android version
- Device model
- Device ID
- Date and time of the last update
- Android version.
- Device model.
- Device ID.
- Date and time of the last update.

![Coaching sessions page](/img/admin_getting_started/sync-log-page.png)
![Coaching sessions page](/img/admin_getting_started/sync-log-page.png)
Loading

0 comments on commit 4f3be7c

Please sign in to comment.