From 78afff270a2f6425053f36b76c7c50cf9a37868b Mon Sep 17 00:00:00 2001
From: pollfly <75068813+pollfly@users.noreply.github.com>
Date: Thu, 11 May 2023 09:15:13 +0300
Subject: [PATCH] Edit sharing experiments page (#556)
---
docs/webapp/webapp_exp_sharing.md | 42 +++++++++++++++----------------
sidebars.js | 4 ++-
2 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/docs/webapp/webapp_exp_sharing.md b/docs/webapp/webapp_exp_sharing.md
index 8f151e2a..9fe9465c 100644
--- a/docs/webapp/webapp_exp_sharing.md
+++ b/docs/webapp/webapp_exp_sharing.md
@@ -2,41 +2,39 @@
title: Sharing Experiments and Models
---
-:::important
+:::info Hosted Service Feature
This is a ClearML Hosted Service feature only.
:::
-**ClearML Hosted Service** users can share experiments with users of another workspace. Sharing an experiment shares its
-models, as well. Shared experiments are read-only, and they can be made private by archiving
-them.
+**ClearML Hosted Service** users can share experiments with users in other workspaces. Sharing an experiment also shares
+all its contents including models, artifacts, and results.
+
+**To share an experiment and its model(s):**
+
+1. Click **Share** in one of these ways:
+
+ * In the [experiment table](webapp_exp_table.md), right-click the experiment **>** **Share**
+ * In the experiment info panel or full screen details view, click
+ (menu) **>** **Share**.
+
+1. Click **Create link**.
+
+1. Copy the hyperlink and send it to a **ClearML Hosted Service** user of another workspace. Any user with this link will have
+read-only access to the experiment and all its contents.
:::note
When a user opens the hyperlink for a shared experiment in their browser, only that experiment appears in the experiment table.
:::
-## Sharing Experiments
-
-Share experiments from the experiments table, the info panel menu, and/or the full screen details menu.
-
-**To share an experiment and its model:**
-
-1. Click **Share** in one of these ways:
-
- * The experiment table - Right-click the experiment **>** **Share**
- * The info panel or full screen details view - Click the experiment **>**
- (menu) **>** **Share**.
-
-1. Click **Create link**.
-
-1. Copy the hyperlink and send it to a **ClearML Hosted Service** user of another workspace.
-
## Making Shared Experiment Private
**To make a shared experiment private again:**
-1. Make private from the experiment table, info panel, or full screen details view (see "Sharing experiments" above).
+1. Click **Share** in one of these ways:
-1. Click **Share**.
+ * The experiment table - Right-click the experiment **>** **Share**
+ * The experiment info panel or full screen details view **>**
+ (menu) **>** **Share**.
1. Click **Remove link**.
diff --git a/sidebars.js b/sidebars.js
index da11a716..05090224 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -66,11 +66,13 @@ module.exports = {
'webapp/webapp_project_overview',
{
'Experiments': ['webapp/webapp_exp_table', 'webapp/webapp_exp_track_visual', 'webapp/webapp_exp_reproducing', 'webapp/webapp_exp_tuning',
- 'webapp/webapp_exp_comparing', 'webapp/webapp_exp_sharing']
+ 'webapp/webapp_exp_comparing']
},
{
'Models': ['webapp/webapp_model_table', 'webapp/webapp_model_viewing']
+
},
+ 'webapp/webapp_exp_sharing'
]
},
{