Skip to content
This repository was archived by the owner on May 9, 2025. It is now read-only.

Commit 6ae587e

Browse files
authored
Merge pull request #181 from DataRecce/feature/drc-1217-document-prepare-the-recce-oss-development-document-review
Refine Recce share document merge to publish it in this week. want to update and discuss after merge - the comment I left for replacing a screenshot - this doc is in Recce Cloud (Alpha) which we are launching (Beta) now. But since I want to [revamp doc](https://www.notion.so/infuseai/Redo-Docs-merge-OSS-Cloud-1d779451d3578076a53fda180cb1086d?pvs=4), can discuss then.
2 parents ef06c0d + a9d4e93 commit 6ae587e

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed
Loading

docs/docs/recce-cloud/share-recce-session-securely.md

+21-8
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,43 @@ Recce Cloud allows you to share your Recce validation results with full context,
1111

1212
!!! Note
1313

14-
Please note that Recce users with the link can visit your sharing session. If you need to restrict access, please contact us.
14+
Please note that anyone with the link can visit your shared Recce after sign in Recce Cloud. If you need to restrict access, [please contact us](https://cal.com/team/recce/chat).
1515

1616
## How to use
1717

18-
1. Obtain API token from Recce Cloud
19-
20-
To connect to your Recce Cloud account, you need an API token. Please copy your API Token from the [personal settings page](https://cloud.datarecce.io/settings#tokens) in Recce Cloud.
18+
When you're ready to share your lineage exploration, query results, or validation checklist, simply click **Share** in Recce.
19+
20+
The first time you do this, you'll need to connect your local Recce to Recce Cloud. This requires signing in and setting up an API token. Once connected, Recce Cloud will host your state file securely, allowing you to share a link that others can open in their browsers.
21+
22+
1. Enable Recce Sharing
23+
24+
To start sharing, launch Recce server and click the **Enable Sharing** button.
25+
26+
![Recce Server](../../assets/images/recce-cloud/recce-server-enable-sharing-fs8.png){: .shadow}
27+
28+
1. Sign in to Recce Cloud and get your API token
29+
30+
Copy your API token from the [personal settings page](https://cloud.datarecce.io/settings#tokens) in Recce Cloud.
31+
2132
![Recce API Token](../../assets/images/recce-cloud/setting-page-api-token-fs8.png){: .shadow}
2233

2334
1. Add the token to `.recce/profile.yml`
2435

25-
For convenience, you can enter your API token in `.recce/profile.yml`, located by default in your home directory.
36+
For convenience, you can add your API token in `.recce/profile.yml`, located by default in your home directory.
2637
```yaml
2738
user_id: <your_user_id>
2839
api_token: <your_api_token>
2940
```
30-
Or, you can use `--api-token` flag with commend for one-time use. e.g.,
41+
Alternatively, for one-time use, you can use `--api-token` flag with commend. e.g.,
3142
```bash
3243
recce server --api-token <your_api_token>
3344
```
3445

35-
1. Start Recce server
46+
1. Relaunch Recce server
47+
48+
After adding the API token, restarting Recce server is required to load the new configuration.
49+
Once it's running, you'll see the **Share** button, then you can click it to get the link on top.
3650

37-
After launching, you'll see the __Share__ button at the top, then you can click it to get the link.
3851
![Recce Share From Server](../../assets/images/recce-cloud/recce-share-from-server-fs8.png){: .shadow}
3952

4053
You can also use the `recce share` command. If you already have a prepared Recce state file, you can obtain a share link directly through the command line.

0 commit comments

Comments
 (0)