Skip to content

Commit 89dee26

Browse files
docs(editor): rename Share Links to Embed URLs (#589)
Also part of [this](rive-app/rive#11994) renaming effort. Since we don't have a nice way to feature-flag things in these docs, we'll merge/deploy these only once the front end has been fully renamed and shipped to Prod
1 parent 5ca2170 commit 89dee26

9 files changed

Lines changed: 33 additions & 29 deletions

File tree

account-admin/account-overview/account-management.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ From here you can:
1111
- Update your email, password, or profile
1212
- Manage your workspaces and billing
1313
- View notifications
14-
- Manage share links for your files
14+
- Manage embed URLs for your files
1515

1616
Your workspaces are listed in the left sidebar. Click "Manage Workspace" next to any workspace to change its plan, update payment, or invite members.
1717

docs.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -209,10 +209,10 @@
209209
]
210210
},
211211
{
212-
"group": "Share Links",
212+
"group": "Embed URLs",
213213
"pages": [
214-
"editor/share-links/overview",
215-
"editor/share-links/framer-and-rive"
214+
"editor/embed-urls/overview",
215+
"editor/embed-urls/framer-and-rive"
216216
]
217217
},
218218
"editor/ai-agent/ai-agent",
@@ -725,6 +725,10 @@
725725
}
726726
},
727727
"redirects": [
728+
{
729+
"source": "/editor/share-links/:slug*",
730+
"destination": "/editor/embed-urls/:slug*"
731+
},
728732
{
729733
"source": "/runtimes/features-support",
730734
"destination": "/feature-support"
Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
---
2-
title: 'Share Links Overview'
2+
title: 'Embed URLs Overview'
33
sidebarTitle: 'Overview'
4-
description: 'Share Links are a fast no-code way to get your Rive files running on a website or to present your graphics to a client.'
4+
description: 'Embed URLs are a fast no-code way to get your Rive files running on a website or to present your graphics to a client.'
55
---
66

7-
<Note>Generating share links is available on Voyager and Enterprise plans. [Learn more about our plans and pricing](https://rive.app/pricing).</Note>
7+
<Note>Generating embed URLs is available on Voyager and Enterprise plans. [Learn more about our plans and pricing](https://rive.app/pricing).</Note>
88

9-
Share the current version of the file you're working with share links. Note that this is not the same as giving someone access to the live file with all its revision history. This link will be a frozen version of the file in its current state. If you make changes to the file, you'll need to generate a new share link.
9+
Share the current version of the file you're working with embed URLs. Note that this is not the same as giving someone access to the live file with all its revision history. This link will be a frozen version of the file in its current state. If you make changes to the file, you'll need to generate a new embed URL.
1010

1111
<Warning>
1212
Certain features, such as [Vector Feathering](https://rive.app/blog/introducing-vector-feathering), are only supported through the Rive Renderer. See our [Feature Support](/feature-support) page for more information.
1313
</Warning>
1414

15-
## Creating a share link
15+
## Creating an embed URL
1616

17-
Generate a share link from the Export menu. This link can be shared with anyone, not just your team members.
17+
Generate an embed URL from the Export menu. This link can be shared with anyone, not just your team members.
1818

1919
![Image](https://1159711764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M3EXlibk6bj2FzPQW-9%2Fuploads%2FpdTtfPZWSbUO2F68xJAi%2FCleanShot%202022-08-01%20at%2015.25.06%402x.png?alt=media&token=637d1c42-e6ed-4ab0-8ee8-2d4aff8df50e)
2020

21-
Choose which artboard, animation, or state machine you want to share in the Share Link modal.
21+
Choose which artboard, animation, or state machine you want to share in the Embed URL modal.
2222

2323
![Image](https://1159711764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M3EXlibk6bj2FzPQW-9%2Fuploads%2FHboa00GCgDOCjmOMJQwu%2FScreen%20Shot%202022-05-19%20at%204.02.59%20PM.png?alt=media&token=dc61a4f5-ef03-490e-8145-cb79eee8b01c)
2424

25-
### Share link options
25+
### Embed URL options
2626

27-
Once you click on the "Generate link" button, several share link types appear:
27+
Once you click on the "Generate link" button, several embed URL types appear:
2828

29-
- **Share link** - Displayed within a border frame on the Rive site at a unique URL. Use this for quickly showing off your Rive creation to clients without having to stage it within the context of a web application yourself
29+
- **Hosted link** - Displayed within a border frame on the Rive site at a unique URL. Use this for quickly showing off your Rive creation to clients without having to stage it within the context of a web application yourself
3030
- **Embed link** - Standalone display of your Rive creation without the context of the border frame. Use this link when you want to embed your Rive creation into other 3rd party platforms that support unfurling and displaying your Rive creation still as a preview (i.e Notion, Tome, Telegram)
3131
- **Embed code** - A code snippet that allows you to embed your Rive creation's embed link in an iframe. This is useful for where you need to drop Rive into a platform where you can edit HTML (i.e Webflow, WordPress, etc.) and you don't want to deal with setting up the creation with a web runtime
3232
- **Framer code (Deprecated)** - See the new official [Rive Framer Plugin](https://www.framer.com/marketplace/plugins/rive/).
@@ -39,15 +39,15 @@ Other options include:
3939

4040
## Integrations
4141

42-
Use share links to embed your Rive files with other well-known tools and platforms! This is not a full list. Most tools will support Rive share links using the methods described here.
42+
Use embed URLs to embed your Rive files with other well-known tools and platforms! This is not a full list. Most tools will support Rive embed URLs using the methods described here.
4343

4444
### Notion
4545

46-
1. Copy the *share* or *embed link*
46+
1. Copy the *hosted* or *embed link*
4747
2. Paste the link in Notion.
4848
3. Select the Embed option that appears in the context menu.
4949

50-
Embed share link in Notion
50+
Embed link in Notion
5151

5252
![Image](https://1159711764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M3EXlibk6bj2FzPQW-9%2Fuploads%2F1QHWSbe4L4gdwkaTLV4x%2FCleanShot%202022-08-01%20at%2015.32.03%402x.png?alt=media&token=a209136e-fe69-4da2-884f-bad0c1e25532)
5353

@@ -65,14 +65,14 @@ Embed share link in Notion
6565
2. In Tome on a slide of your choosing, add a web link
6666
3. Paste the embed link you copied from the Rive editor
6767

68-
![Embed share link in Tome](https://1159711764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M3EXlibk6bj2FzPQW-9%2Fuploads%2FRQDfIWCWxjJ9XBGC3wBG%2FScreen%20Shot%202022-05-19%20at%207.32.34%20PM.png?alt=media&token=f88e48a4-cfd4-4fc6-890d-acc24b479f71)
68+
![Embed link in Tome](https://1159711764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M3EXlibk6bj2FzPQW-9%2Fuploads%2FRQDfIWCWxjJ9XBGC3wBG%2FScreen%20Shot%202022-05-19%20at%207.32.34%20PM.png?alt=media&token=f88e48a4-cfd4-4fc6-890d-acc24b479f71)
6969

7070
### Social Media
7171

72-
1. Copy the *share link*
72+
1. Copy the *hosted link*
7373
2. Paste it into your favorite platform
7474
3. See your Rive creation unfurl when you post
7575

76-
## Managing share links
76+
## Managing embed URLs
7777

78-
Visit the [Share Links](https://rive.app/profile/?section=share%20links) section of your settings to manage the links you've generated. You can disable a share link by setting its Active toggle to off.
78+
Visit the [Embed URLs](https://rive.app/account/links) section of your settings to manage the links you've generated. You can disable an embed URL by setting its Active toggle to off.

editor/events/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ The Target tells the user's browser where this URL should open. We have a few op
7878
- Self - Opens in the current browsing context
7979
- Top - Opens in the topmost browsing context (the "highest" context that's an ancestor of the current one). If no ancestors, behaves as `Self`.
8080

81-
<Info>At this time, by default, Rive will not open URLs when this type of event is reported in share links or Marketplace posts due to security considerations. However, this may change in the future</Info>
81+
<Info>At this time, by default, Rive will not open URLs when this type of event is reported in embed URLs or Marketplace posts due to security considerations. However, this may change in the future</Info>
8282

8383
## Signaling an Event
8484

editor/interface-overview/toolbar.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ The export section allows you to both export your Rive file, and export or remov
2727

2828
Read more about exporting a Rive file and its contents [here](https://rive.app/docs/editor/exporting/exporting-for-runtime).
2929

30-
**Generate Share Link**
30+
**Generate Embed URL**
3131

32-
<Note>Generating share links is available on Voyager and Enterprise plans. [Learn more about our plans and pricing](https://rive.app/pricing).</Note>
32+
<Note>Generating embed URLs is available on Voyager and Enterprise plans. [Learn more about our plans and pricing](https://rive.app/pricing).</Note>
3333

34-
Share Links are a fast no-code way to get your Rive files running on a website or to present your graphics to a client.
34+
Embed URLs are a fast no-code way to get your Rive files running on a website or to present your graphics to a client.
3535

36-
![Share link](/images/sharelink.gif)
36+
![Embed URL](/images/sharelink.gif)
3737

38-
Share the current version of the file you’re working with share links. Note that this is not the same as giving someone access to the live file with all its revision history. This link will be a frozen version of the file in its current state. If you make changes to the file, you’ll need to generate a new share link.
38+
Share the current version of the file you’re working with embed URLs. Note that this is not the same as giving someone access to the live file with all its revision history. This link will be a frozen version of the file in its current state. If you make changes to the file, you’ll need to generate a new embed URL.
3939

40-
Learn more about share links [here](https://rive.app/docs/editor/share-links/overview).
40+
Learn more about embed URLs [here](https://rive.app/docs/editor/embed-urls/overview).
4141

4242
**Publish to Marketplace**
4343

@@ -237,7 +237,7 @@ Show Final Playback automatically hides all elements and visualizations that wou
237237
## Export Button
238238

239239

240-
The Export button allows you to create [Share Links](/editor/share-links/overview), [publish a file to the Marketplace](/community/marketplace-overview#marketplace-overview), [download a `.riv` file](/editor/exporting/exporting-for-runtime), and [publish a library](/editor/libraries).
240+
The Export button allows you to create [Embed URLs](/editor/embed-urls/overview), [publish a file to the Marketplace](/community/marketplace-overview#marketplace-overview), [download a `.riv` file](/editor/exporting/exporting-for-runtime), and [publish a library](/editor/libraries).
241241

242242
![Export](/images/export.png)
243243

images/editor/share-links/8be626b1-c9b1-4f1b-ae24-9ad24376740a.webp renamed to images/editor/embed-urls/8be626b1-c9b1-4f1b-ae24-9ad24376740a.webp

File renamed without changes.

images/editor/share-links/c4628cfc-1609-4a91-a92b-872d82d51fda.webp renamed to images/editor/embed-urls/c4628cfc-1609-4a91-a92b-872d82d51fda.webp

File renamed without changes.

images/editor/share-links/f80052b3-bee4-4347-8da7-e1cf4b68e076.webp renamed to images/editor/embed-urls/f80052b3-bee4-4347-8da7-e1cf4b68e076.webp

File renamed without changes.

0 commit comments

Comments
 (0)