Skip to content

Commit 7066736

Browse files
committed
Add docs for recce share
Signed-off-by: Wei-Chun, Chang <[email protected]>
1 parent 7990a81 commit 7066736

File tree

5 files changed

+42
-0
lines changed

5 files changed

+42
-0
lines changed
19.1 KB
Loading
27.9 KB
Loading
55.6 KB
Loading
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Share Recce Session
3+
icon: material/account-eye
4+
---
5+
6+
If you've already used Recce to validate your PR and prepared checks, but stakeholders might not have the environment to run Recce. Recce Cloud allows you to quickly and easily share your Recce validation results. Just click your share link to open a read-only Recce instance directly in the browser with __no local setup required__, so your reviewers or stakeholders can quickly join the review process.
7+
8+
!!! Note
9+
10+
Please note that Recce users with the link can visit your sharing session.
11+
12+
## How to use
13+
14+
1. Obtain API token from Recce Cloud
15+
16+
To connect to your Recce Cloud account, you need an API token. Please copy your API Token from the personal settings page in Recce Cloud.
17+
![Recce API Token](../../assets/images/recce-cloud/setting-page-api-token-fs8.png){: .shadow}
18+
19+
1. Add the token to `.recce/profile.yml`
20+
21+
For convenience, you can enter your API token in `.recce/profile.yml`, located by default in your home directory.
22+
```yaml
23+
user_id: <your_user_id>
24+
api_token: <your_api_token>
25+
```
26+
Or, you can use `--api-token` flag with commend for one-time use. e.g.,
27+
```bash
28+
recce server --api-token <your_api_token>
29+
```
30+
31+
1. Start Recce server
32+
33+
After launching, you'll see the __Share__ button at the top, then you can click it to get the link.
34+
![Recce Share From Server](../../assets/images/recce-cloud/recce-share-from-server-fs8.png){: .shadow}
35+
36+
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.
37+
```bash
38+
recce share <your_state_file>
39+
recce share --api-token <your_api_token> <your_state_file> # for one-time use
40+
```
41+
![Recce Share From CLI](../../assets/images/recce-cloud/recce-share-from-cli.png){: .shadow}

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ nav:
7676
- docs/recce-cloud/setup-gh-actions.md
7777
- docs/recce-cloud/setup-gh-codespaces.md
7878
- docs/recce-cloud/expose-recce-instance-visibility.md
79+
- docs/recce-cloud/share-recce-session-securely.md
7980
- Cloud Architecture:
8081
# - docs/recce-cloud/architecture/index.md
8182
- docs/recce-cloud/architecture/security.md

0 commit comments

Comments
 (0)