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

docs: user officer pages restructure #712

Merged
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
Binary file added documentation/docs/assets/images/fap.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 documentation/docs/assets/images/sample_esi.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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
279 changes: 147 additions & 132 deletions documentation/docs/faq.md

Large diffs are not rendered by default.

352 changes: 289 additions & 63 deletions documentation/docs/glossary.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion documentation/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![UOS Logo](assets/images/uo_logo.png){ align=left, width="300" }
![UOS Logo](assets/images/uo_logo_small.png){ align=left, width="300" }

## Welcome to User Office

Expand Down
41 changes: 41 additions & 0 deletions documentation/docs/user-guide/user-officer/calls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Calls :material-calendar-blank:

## **What are calls?**

??? info "Calls"
**Calls** :material-calendar-blank: allow users’ **proposals** :material-folder-outline: to be submitted and managed within User Office. A call is a period of time during which users can submit proposals to a facility. Calls have a start and an end date and are linked to several different kinds of [**templates :material-text-box-multiple:**](templates/templates.md) (such as [**proposal templates**](templates/proposal_template.md) which act as the questionnaire that users must fill out when creating their proposals). Calls are assigned to [**FAPs**](fap.md) (Facility Access Panels) for proposal review and evaluation. Calls are also linked to a [**proposal workflow**](proposal_workflow.md), which dictates the lifecycle of the proposals within a call.

* The [**templates** :material-text-box-multiple:](templates/templates.md) allow User Officers to customise calls with specific requirements regarding the type of research users may conduct. Templates also specify and collect the information that users must provide in order to facilitate their research.

* The [**FAP (Facility Access Panel)**](fap.md) is the group responsible for evaluating users' research proposals which are assigned to proposals and calls.

* The [**proposal workflow**](proposal_workflow.md) specifies which stages the proposals assigned to the call will go through. This is configured by defining the [**events**](proposal_workflow.md) that must occur in order for proposals to progress to the next [**status :material-folder-cog-outline:**](proposal_workflow.md).

______________________________________________________________________________________

## **How do I create a call?**

See the [**creating a call**](creating_call.md) guide.
______________________________________________________________________________________

## **How do I edit an active call?**

**Best practice for editing active calls**

Once a call has been created it becomes `ACTIVE` meaning that it is open for users to submit their proposals. Therefore, if changes are made to active calls proposals submitted after the update may be different. This may cause disavdantage to users, therefore User Officers must take care to ensure that

All active calls can be seen by filtering by 'Active' Status within the the Calls page. Active calls can be edited by clicking on the `EDIT` :material-pencil: action. This opens the update call pop-up. Once you have made the desired changes, click on `UPDATE` to update the call. See more information about the call sections and information on the [**'Creating a call' page**](creating_call.md)

______________________________________________________________________________________

## **How do I manage calls?**

### **How do I assign instruments to a call?**

### **How do I deactivate calls?**

### **How do I delete calls?**

### **How do I export FAP data from a call?**

### **What do #Instruments, #proposals and #faps mean on calls?**
11 changes: 0 additions & 11 deletions documentation/docs/user-guide/user-officer/editing_call.md

This file was deleted.

3 changes: 3 additions & 0 deletions documentation/docs/user-guide/user-officer/experiments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Experiments

## **What are experiments?**
21 changes: 14 additions & 7 deletions documentation/docs/user-guide/user-officer/fap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

* [**User Officers**](roles.md) can manage the FAPs assigned to proposals and provide general information such as labeling FAPs with a code, a description, and specifying the required number of proposal ratings. FAPs can be automatically assigned to all proposals within a call, helping streamline the organisation and operation of the review process. This ensures that proposals are evaluated efficiently and according to standardised criteria such as the **grade guide**.


_____________________________________________________________________________________________________

#### **How do I edit FAPs?**

Expand All @@ -16,6 +16,8 @@

* You can update changes to the General tab with the `UPDATE FAP` button. Changes made within other tabs such as editing the FAP members will be updated automatically.

_____________________________________________________________________________________________________

#### **How do I create FAPs?**

* In the main menu, head to the FAPs page.
Expand Down Expand Up @@ -58,21 +60,21 @@ The FAP members can be configured.

**Logs**


### Instruments and FAP important information

* Proposals with multiple instruments have a different distribution of time allocation
_____________________________________________________________________________________________________


### **How do I configure the system for FAP review?**


___________________________________________________________________________________________________

### **What is the grade guide?**

_____________________________________________________________________________________________________


### **How are FAPs with multiple instruments configured?**

### **Multiple FAP reviewal of proposal**
* Proposals with multiple instruments have a different distribution of time allocation.

To generate a cutoff, we need the amount of instrument time available per instrument and the amount of time recommended per instrument.

Expand All @@ -87,3 +89,8 @@ Therefore in the case where instrument 1 has 10 days available to be shared in F

FAP 1 has a cutoff at (10/25)*15 or 6 days
FAP 2 has a cutoff at (10/25)*10 or 4 days





4 changes: 4 additions & 0 deletions documentation/docs/user-guide/user-officer/institutions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Institutions :material-bank:

## **What are institutions?**

3 changes: 3 additions & 0 deletions documentation/docs/user-guide/user-officer/instruments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Instruments :material-microscope:

## **What are instruments?**
Loading
Loading