Skip to content

Commit 9dd113d

Browse files
Docs fixup (#629)
* Documentation fixup * Fix typo in docs Co-authored-by: Zach Mullen <zach.mullen@kitware.com>
1 parent 4addb38 commit 9dd113d

3 files changed

Lines changed: 7 additions & 3 deletions

File tree

docs/setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Specific instructions including commands can be found in [prod/README.md](prod/README.md). Those instructions will offer a step-by-step guide for commands to run for configuration. This guide is preparatory material for those instructions, which assume you already have some prerequisite components and server experience. Below are some explanations of these prerequisites, which you may need to spend some time to understand and obtain from your organization before you can get started with the production instructions.
1+
Specific instructions including commands can be found in [prod/README.md](https://github.com/OpenImaging/miqa/tree/master/prod). Those instructions will offer a step-by-step guide for commands to run for configuration. This guide is preparatory material for those instructions, which assume you already have some prerequisite components and server experience. Below are some explanations of these prerequisites, which you may need to spend some time to understand and obtain from your organization before you can get started with the production instructions.
22

33
### Server machine preparation
44

@@ -21,7 +21,7 @@ Some helpful hints for using docker-compose:
2121

2222
### Mail server
2323

24-
MIQA has an email feature that allows users to send screenshots of scan slices to colleagues. As such, the MIQA server needs a specialized mail server to send those emails. There are many options for free open source mail servers for enterprise or personal use. Our documentation (see [production instructions](prod/README.md)) recommends Mailtrap, which only requires an account for their online portal . If your organization has some other standard for mail servers, that option is equally compatible with MIQA. You simply need to obtain the values for `host`, `port`, `user`, and `password` for the mail server you choose. The production instructions will specify how to use these values in the configuration.
24+
MIQA has an email feature that allows users to send screenshots of scan slices to colleagues. As such, the MIQA server needs a specialized mail server to send those emails. There are many options for free open source mail servers for enterprise or personal use. Our documentation (see [production instructions](https://github.com/OpenImaging/miqa/tree/master/prod)) recommends Mailtrap, which only requires an account for their online portal. If your organization has some other standard for mail servers, that option is equally compatible with MIQA. You simply need to obtain the values for `host`, `port`, `user`, and `password` for the SMTP server you choose. The production instructions will specify how to use these values in the configuration.
2525

2626
### SSL certificates
2727

docs/site.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ The previous decisions displayed in this box are shown in reverse chronological
9999
6. *The date*. This is the date on which the decision was saved.
100100

101101
#### Additional items on the scan viewing page
102-
1. *The context sidebar*. The left edge of this page includes a sidebar that expands upon hovering. This sidebar shows the same content as the experiments list on the project page. This acts as a navigational tool as the user continues down the list of scans in each experiment. The user’s icon will be shown next to the experiment they are currently viewing to represent that they have exclusive edit access (see Control Panel > Exclusive edit access for an experiment for details). Clicking any scan in this list will bring the user to that scan. Note that the review mode toggle exists here, too, so the user may filter/unfilter the queue of scans to flip through.
102+
1. *The context sidebar*. The left edge of this page includes a sidebar that expands upon hovering. This sidebar shows the same content as the experiments list on the project page. This acts as a navigational tool as the user continues down the list of scans in each experiment. The user’s icon will be shown next to the experiment they are currently viewing to represent that they have exclusive edit access (see Control Panel > Exclusive edit access for an experiment for details). Clicking any scan in this list will bring the user to that scan. Note that the review mode toggle exists here, too, so the user may filter/unfilter the queue of scans to flip through. By default, this toggle is enabled, so complete scans will be disabled and written in gray text. To access these scans, simply turn off the filtering by switching the toggle to "All scans".
103103

104104
**![](images/site_16.png)**
105105

docs/users.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,13 @@ Once the email verification process has been completed, a second email will be s
88
All users in MIQA have both a global role and a role on every project to which they are added. Possible roles are as follows:
99

1010
Global roles
11+
1112
- Superuser
1213
- Normal user
14+
15+
1316
Project Roles
17+
1418
- Creator
1519
- Tier 2 reviewer
1620
- Tier 1 Reviewer

0 commit comments

Comments
 (0)