Skip to content

Commit b4ee419

Browse files
committed
Clarify share previews are for public apps only
1 parent d692482 commit b4ee419

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

content/streamlit-cloud/get-started/share-your-app/share-previews.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,19 @@ slug: /streamlit-cloud/get-started/share-your-app/share-previews
55

66
# Share previews
77

8-
Social media sites generate a card with a title, preview image, and description when you share a link. This feature is called a "share preview." In the same way, when you share a link to a Streamlit app on social media, a share preview is also generated. Here's an example of a share preview for a public Streamlit app posted on Twitter:
8+
Social media sites generate a card with a title, preview image, and description when you share a link. This feature is called a "share preview." In the same way, when you share a link to a public Streamlit app on social media, a share preview is also generated. Here's an example of a share preview for a public Streamlit app posted on Twitter:
99

10-
![Share preview for a public Streamlit app](/images/streamlit-cloud/share-preview-twitter-annotated.png)
10+
<div style={{ marginLeft: '3em' }}>
11+
<Flex>
12+
<Image caption="Share preview for a public Streamlit app" src="/images/streamlit-cloud/share-preview-twitter-annotated.png" />
13+
</Flex>
14+
</div>
15+
16+
<Note>
17+
18+
Share previews are generated only for public apps deployed on Community Cloud.
19+
20+
</Note>
1121

1222
## Titles
1323

@@ -29,26 +39,24 @@ There are two ways to set the title of a share preview:
2939

3040
## Descriptions
3141

32-
The description is the text that appears below the title in the share preview. The description should summarize what the app does and ideally should be under 160 characters.
42+
The description is the text that appears below the title in the share preview. The description should summarize what the app does and ideally should be under 100 characters.
3343

3444
Streamlit pulls the description from the README in the app's GitHub repository. If there is no README, the description will default to:
3545

3646
_This app was built in Streamlit! Check it out and visit https://streamlit.io for more awesome community apps. 🎈_
3747

38-
If you want your share previews to look great and want users to share your app and click on your links, you should write a good description in the README of your app’s GitHub repository
48+
<div style={{ marginLeft: '10em' }}>
49+
<Flex>
50+
<Image caption="Default share preview when a description is missing" src="/images/streamlit-cloud/share-preview-private-app.png" />
51+
</Flex>
52+
</div>
53+
54+
If you want your share previews to look great and want users to share your app and click on your links, you should write a good description in the README of your app’s GitHub repository.
3955

4056
## Preview images
4157

4258
Community Cloud takes a screenshot of your app once a day and uses it as the preview image, unlike titles and descriptions, which are pulled directly from your app's code or GitHub repository. This screenshot may take up to 24 hours to update.
4359

44-
## Public vs. private apps
45-
46-
All of the above information applies to public apps. If you share a private app, the share preview will contain no information about your app. Instead, it will include a default title ("Streamlit app"), a default description ("This app was built in Streamlit! Check it out and visit https://streamlit.io for more awesome community apps. 🎈"), and a default preview image that contains the Streamlit logo:
47-
48-
<div style={{ marginLeft: '10em' }}>
49-
<Flex>
50-
<Image caption="Default share preview for a private app" src="/images/streamlit-cloud/share-preview-private-app.png" />
51-
</Flex>
52-
</div>
60+
## Switching your app from public to private
5361

54-
If your app was initially public and you later made it private, the share preview will no longer contain any information about your app. It will look like the image above, containing a generic title, description, and image. However, the last publicly available data will be discoverable for up to 24 hours after the app is made private.
62+
If you initially made your app public and later decided to make it private, we will stop generating share previews for the app. However, it may take up to 24 hours for the share previews to stop appearing.

0 commit comments

Comments
 (0)