Skip to content
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
31 changes: 19 additions & 12 deletions medcat-trainer/docs/admin_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,30 @@ Before first startup in production-like environments, set:
If not set, MedCATtrainer defaults to `admin` / `admin`, which is not suitable
for production.

## 2) Sign in and create operational admin users
## 2) Sign in

You can manage users from:
Staff and superuser accounts see a cog icon at the top-right of the header.
That opens **Project Administration** (`/project-admin`), used to set up
users, datasets, model packs, projects, and project groups. See
[Project Administration](project_admin.md).

- **Project Admin UI** (`/project-admin`) for day-to-day project operations
- **Django Admin** (`/admin`) for full platform administration
Django Admin (`/admin`) remains the place for full platform administration,
including passwords and actions this screen does not cover.

In Django admin (`/admin`), create at least one dedicated administrator account
and grant:
Create at least one dedicated administrator and grant:

- `Staff status` for admin access
- `Superuser status` for full unrestricted access
- `Staff status`, so the account can open the cog icon
- `Superuser status`, for unrestricted access, including Django admin

## 3) Create annotator users

Create users for annotators and add them to project membership lists.
Annotators do not need staff/superuser flags.
Add annotators from the **Users** tab on Project Administration, then add
them to a project or project group. Annotators do not need staff or
superuser flags.

The password field on that form is not stored. Set each password in Django
admin (`/admin` -> **Users**), or through the password-reset flow, before
the person signs in.

## 4) Remove or rotate bootstrap credentials

Expand All @@ -42,7 +49,7 @@ After creating named administrator accounts:

When `USE_OIDC=1`, user permissions are mapped from IdP roles:

- `medcattrainer_superuser` -> Django superuser + staff
- `medcattrainer_staff` -> Django staff
- `medcattrainer_superuser` -> Django superuser + staff. This role shows the cog icon.
- `medcattrainer_staff` -> Django staff. This role does not show the cog icon.

Ensure role assignment is correct in Keycloak before onboarding users.
1 change: 1 addition & 0 deletions medcat-trainer/docs/advanced_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Modern project-admin UI uses dedicated endpoints:
- `GET/PUT/DELETE /api/project-admin/projects/<project_id>/`
- `POST /api/project-admin/projects/<project_id>/clone/`
- `POST /api/project-admin/projects/<project_id>/reset/`
- `POST /api/project-groups/` creates a project group and, by default, one annotation project per annotator

## Project Group APIs

Expand Down
2 changes: 1 addition & 1 deletion medcat-trainer/docs/annotator_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ The sidebar shows details for the currently selected concept, including:
If enabled by project settings, a **Comment** field is also available.

!!! tip
If the details are not showing in the sidebar after you've selected one, the issue is likely with an unfinished Project setup. See the section for "Concept lookup index (Solr import)" in the [Project Creation and Management Guide](project_admin.md) for details.
If the details are not showing in the sidebar after you've selected one, the issue is likely with an unfinished Project setup. See [Concept lookup index (Solr import)](project_admin.md#concept-lookup-index-solr-import) in the Project Administration guide.

## Meta annotations

Expand Down
6 changes: 4 additions & 2 deletions medcat-trainer/docs/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ required.
- `get_meta_tasks()`
- `get_rel_tasks()`
- `get_projects()`
- `create_project_group(...)`
- `get_project_groups()`
- `get_datasets()`
- `get_project_annos(projects)`
- `upload_projects_export(...)`
Expand All @@ -108,8 +110,8 @@ required.

## Notes

- `create_project` and `create_project_group` expect **either** `modelpack`
**or** `concept_db + vocab`.
- `create_project` and `create_project_group` expect **either** `modelpack` **or** `concept_db + vocab`.
- `create_project_group` creates one annotation project per annotator when `create_associated_projects` is left at its default, `True`.
- Wrapper objects (`MCTDataset`, `MCTConceptDB`, etc.) can often be passed by
object or resolved by name.
- See [Project Groups](project_group_admin.md) for the UI workflow these client
Expand Down
8 changes: 6 additions & 2 deletions medcat-trainer/docs/django_admin.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Django Admin

The **Django Admin** (`/admin`) provides advanced actions and low-level data
management that are not available in the Project Admin UI (`/project-admin`).
management that are not available from the cog icon
([Project Administration](project_admin.md), `/project-admin`).

These include:
Use it to edit an existing **project group** and push those settings onto its
projects, to attach projects that were created separately, to set user
passwords, and for the actions below. Creating a project or a new project
group is done from the cog icon.



Expand Down
4 changes: 2 additions & 2 deletions medcat-trainer/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ review-only workflows (collect annotations without changing the model).

1. Install and configure MedCATtrainer.
2. Create users and upload model artifacts (Model Pack or CDB/Vocab). [Administrator Setup](admin_setup.md)
3. Create a project and assign annotators. [Annotation Project Creation and Management](project_admin.md)
3. Open the cog icon and create a project or a project group, then assign annotators. [Project Administration](project_admin.md)
4. Annotate and submit documents. [Annotator Guide](annotator_guide.md)
5. Export annotations and evaluate with the metrics tools.

## Documentation map

- [Installation](installation.md)
- [Administrator Setup](admin_setup.md)
- [Annotation Project Creation and Management](project_admin.md)
- [Project Administration](project_admin.md)
- [Project Groups](project_group_admin.md)
- [Django Admin](django_admin.md)
- [Annotator Guide](annotator_guide.md)
Expand Down
Loading
Loading