Skip to content

Repository navigation

docs(CON-647): map the run sharing commands to the Console #776

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.

Sign up for GitHub

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

Draft
tobi-ax wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(CON-647): map the run sharing commands to the Console #776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@
| Launchpad | Console: [https://platform.aignostics.com](https://platform.aignostics.com) |
| SDK upload command for the Console | Console: [https://platform.aignostics.com](https://platform.aignostics.com) |

#### Sharing runs

In the Console, open the run and select **Share**. Only the run's owners see the button: the user who submitted the run and the admins of its organization. Every share gives read-only access.

| You use | Use this instead |
| --- | --- |
| `aignostics application run share organization grant RUN_ID` | **Share**, then **Share with my organization** |
| `aignostics application run share organization grant RUN_ID ORG_ID` | **Share**, then paste the ID under **Another organization** |
| `aignostics application run share token create RUN_ID` | **Share**, then **Create link** under **Link**. The link expires after 1, 7, 30 or 90 days, or never. The Console shows it once. |
| `aignostics application run share status RUN_ID`, `share organization list`, `share token list` | **Share** lists who can open the run: its owners, the organizations and the links |
| `aignostics application run share organization revoke`, `share token revoke` | **Revoke** next to the organization or link in that list |
| `--share-token` on `run describe`, `run dump-metadata`, `run dump-item-metadata` and `run result download` | Open the link in a browser. After login it shows the run, its items and metadata, with the results to download and the slides in the viewer. |

[![License](https://img.shields.io/github/license/aignostics/python-sdk?logo=opensourceinitiative&logoColor=3DA639&labelColor=414042&color=A41831)](https://github.com/aignostics/python-sdk/blob/main/LICENSE)
[![Python Version](https://img.shields.io/pypi/pyversions/aignostics.svg?logo=python&color=204361&labelColor=1E2933)](https://pypi.org/project/aignostics/)
[![CI/CD](https://github.com/aignostics/python-sdk/actions/workflows/ci-cd.yml/badge.svg?branch=main)](https://github.com/aignostics/python-sdk/actions/workflows/ci-cd.yml)
Expand Down
13 changes: 13 additions & 0 deletions docs/partials/README_header.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,19 @@
| Launchpad | Console: [https://platform.aignostics.com](https://platform.aignostics.com) |
| SDK upload command for the Console | Console: [https://platform.aignostics.com](https://platform.aignostics.com) |

#### Sharing runs

In the Console, open the run and select **Share**. Only the run's owners see the button: the user who submitted the run and the admins of its organization. Every share gives read-only access.

| You use | Use this instead |
| --- | --- |
| `aignostics application run share organization grant RUN_ID` | **Share**, then **Share with my organization** |
| `aignostics application run share organization grant RUN_ID ORG_ID` | **Share**, then paste the ID under **Another organization** |
| `aignostics application run share token create RUN_ID` | **Share**, then **Create link** under **Link**. The link expires after 1, 7, 30 or 90 days, or never. The Console shows it once. |
| `aignostics application run share status RUN_ID`, `share organization list`, `share token list` | **Share** lists who can open the run: its owners, the organizations and the links |
| `aignostics application run share organization revoke`, `share token revoke` | **Revoke** next to the organization or link in that list |
| `--share-token` on `run describe`, `run dump-metadata`, `run dump-item-metadata` and `run result download` | Open the link in a browser. After login it shows the run, its items and metadata, with the results to download and the slides in the viewer. |

[![License](https://img.shields.io/github/license/aignostics/python-sdk?logo=opensourceinitiative&logoColor=3DA639&labelColor=414042&color=A41831)](https://github.com/aignostics/python-sdk/blob/main/LICENSE)
[![Python Version](https://img.shields.io/pypi/pyversions/aignostics.svg?logo=python&color=204361&labelColor=1E2933)](https://pypi.org/project/aignostics/)
[![CI/CD](https://github.com/aignostics/python-sdk/actions/workflows/ci-cd.yml/badge.svg?branch=main)](https://github.com/aignostics/python-sdk/actions/workflows/ci-cd.yml)
Expand Down
Loading