diff --git a/README.md b/README.md index 148702ff5..72e674d8a 100644 --- a/README.md +++ b/README.md @@ -132,6 +132,18 @@ manage your organization, applications, quotas, and users registered with the Ai 2. Administrators of your organization can invite additional users, manage the organisation and user specific quotas and monitor usage. 3. Both roles can trigger application runs. +#### Inviting and managing users + +If you have the Administrator role, you invite colleagues to your organization directly from the Console: + +1. Log in to the [Console](https://platform.aignostics.com) and select **Admin** in the sidebar, then open **Members**. +2. At the bottom of the Members page, enter the colleague's email address and assign a role: + - **Member** — a regular user who can run applications and manage their own runs. + - **Admin** — everything a member can do, plus inviting and managing other users. +3. Click **Send**. The colleague receives a signup email from `support@aignostics.com` inviting them to accept the invitation, set a password, and configure two-factor authentication. + +The email address must use your organization's official domain (see the registration requirements above). Return to the Members page at any time to review your organization's users and their roles. + ### Applications An application is a fully automated advanced machine learning based workflow composed of one or more specific tasks (e.g. Tissue Quality Control, Tissue Segmentation, Cell Detection, Cell Classification and predictive analysis). Each application is designed for a particular analysis purpose (e.g. Tumor Micro Environment analysis or biomarker scoring). For each application we define input requirements, processing tasks and output formats. diff --git a/docs/partials/README_platform.md b/docs/partials/README_platform.md index ed135b6a2..d5b8e3b35 100644 --- a/docs/partials/README_platform.md +++ b/docs/partials/README_platform.md @@ -37,6 +37,18 @@ manage your organization, applications, quotas, and users registered with the Ai 2. Administrators of your organization can invite additional users, manage the organisation and user specific quotas and monitor usage. 3. Both roles can trigger application runs. +#### Inviting and managing users + +If you have the Administrator role, you invite colleagues to your organization directly from the Console: + +1. Log in to the [Console](https://platform.aignostics.com) and select **Admin** in the sidebar, then open **Members**. +2. At the bottom of the Members page, enter the colleague's email address and assign a role: + - **Member** — a regular user who can run applications and manage their own runs. + - **Admin** — everything a member can do, plus inviting and managing other users. +3. Click **Send**. The colleague receives a signup email from `support@aignostics.com` inviting them to accept the invitation, set a password, and configure two-factor authentication. + +The email address must use your organization's official domain (see the registration requirements above). Return to the Members page at any time to review your organization's users and their roles. + ### Applications An application is a fully automated advanced machine learning based workflow composed of one or more specific tasks (e.g. Tissue Quality Control, Tissue Segmentation, Cell Detection, Cell Classification and predictive analysis). Each application is designed for a particular analysis purpose (e.g. Tumor Micro Environment analysis or biomarker scoring). For each application we define input requirements, processing tasks and output formats. diff --git a/docs/partials/_invite_your_team.md b/docs/partials/_invite_your_team.md new file mode 100644 index 000000000..17a9b14b4 --- /dev/null +++ b/docs/partials/_invite_your_team.md @@ -0,0 +1,18 @@ +## Invite your team + +If you are your organization's **Administrator**, you can invite colleagues onto the Aignostics Platform so they can run analyses too. + +> 💡 **Not an administrator?** Skip this section — ask whoever set up your organization's account to invite you. + +1. **Open the members page.** Log in to the [Aignostics Console](https://platform.aignostics.com), select **Admin** in the sidebar, then open **Members**. + +2. **Add a colleague and choose their role.** At the bottom of the Members page, enter their email address and assign a role: + + - **Member** — can run applications and manage their own runs. + - **Admin** — everything a member can do, plus inviting and managing other users. + + > ⚠️ The email address must use your organization's own domain — the same domain as yours. + +3. **Send the invitation.** Click **Send**. Your colleague receives a signup email from `support@aignostics.com` and completes the same steps you did — see **Sign up for the Aignostics Platform** at the start of this guide. + +Return to the Members page any time to review your organization's users and their roles. diff --git a/docs/partials/get_started_cli.md b/docs/partials/get_started_cli.md index 31b8fca53..e25945a20 100644 --- a/docs/partials/get_started_cli.md +++ b/docs/partials/get_started_cli.md @@ -117,3 +117,6 @@ To check system health manually: ```shell uvx aignostics system health ``` + +```{include} ../partials/_invite_your_team.md +``` diff --git a/docs/partials/get_started_launchpad.md b/docs/partials/get_started_launchpad.md index 5c2103a71..71014b220 100644 --- a/docs/partials/get_started_launchpad.md +++ b/docs/partials/get_started_launchpad.md @@ -129,6 +129,9 @@ Your slide appears in QuPath with the analysis annotations layered on top — ti **Congratulations** — you have signed up, installed Launchpad, run your first analysis, and opened the results in QuPath. +```{include} ../partials/_invite_your_team.md +``` + ## Troubleshooting
diff --git a/docs/partials/get_started_library.md b/docs/partials/get_started_library.md index 0eb8bac21..1c4501251 100644 --- a/docs/partials/get_started_library.md +++ b/docs/partials/get_started_library.md @@ -132,3 +132,6 @@ The `download_url` is a signed URL that allows the Aignostics Platform to downlo To make whole slide images available to the Aignostics Platform, you provide a signed URL the platform can download from. Signed URLs for files in Google Cloud Storage buckets can be generated with `generate_signed_url` ([code](https://github.com/aignostics/python-sdk/blob/main/src/aignostics/platform/_utils.py)). **You must provide the [required credentials](https://cloud.google.com/docs/authentication/application-default-credentials) for the Google Cloud Storage bucket.** + +```{include} ../partials/_invite_your_team.md +``` diff --git a/docs/partials/get_started_mcp.md b/docs/partials/get_started_mcp.md index f652e3ee7..ba83a6343 100644 --- a/docs/partials/get_started_mcp.md +++ b/docs/partials/get_started_mcp.md @@ -83,3 +83,6 @@ Plugins register themselves via Python entry points; their tools are automatical ## What AI agents can do Once configured, AI agents can help with platform operations through natural language, using the tools exposed by the SDK and any installed plugins. + +```{include} ../partials/_invite_your_team.md +```