Skip to content

Commit 474b878

Browse files
Add Codespaces to Community Cloud docs (#809)
* Add Codespaces to Community Cloud Quickstart * Add instructions to edit with Codespaces * Add links to Codespaces within Community Cloud * Add link to Codespaces in Library Get started * Style and typesetting * Update What's new * Typos and style * Added Fork and edit page
1 parent 99070f7 commit 474b878

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+245
-58
lines changed

content/library/get-started/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@ operating system, and how to create your first Streamlit app!
2121
<InlineCallout color="violet-70" icon="auto_stories" bold="Multipage apps" href="/library/get-started/multipage-apps">
2222
teaches you how to add pages to your app, including how to define pages, structure and run multipage apps, and navigate between pages. Once you understand the basics, create your first multipage app based on the familiar <code>streamlit hello</code> command!
2323
</InlineCallout>
24-
{/*<InlineCallout color="violet-70" icon="share" bold="Deploy an app" href="/library/get-started/deploy-an-app">
25-
to Streamlit Community Cloud. With Streamlit Community Cloud your data team can directly serve the needs of the rest of the company. Quickly go from data to app, from prototype to production. Share apps in one click and collaborate instantly with live code updates.
26-
</InlineCallout>*/}
24+
<p>If you want to skip past local installation, try out our Community Cloud <a href="/streamlit-community-cloud/get-started/quickstart">Quickstart</a> to quickly fork an app and jump into a codespace to develop in the cloud. Return to Streamlit library <a href="/library/get-started/main-concepts">Main concepts</a> to learn how to code a Streamlit app.</p>
25+
<InlineCallout color="l-blue-70" icon="rocket_launch" bold="Quickstart" href="/streamlit-community-cloud/get-started/quickstart">
26+
takes you through creating a Streamlit Community Cloud account. Once you have your account, fork and deploy a sample Streamlit app then jump into editing code with GitHub Codespaces. No installation required!
27+
</InlineCallout>
2728
</InlineCalloutContainer>
2829

2930
<NoteSplit

content/library/get-started/installation.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ slug: /library/get-started/installation
55

66
# Install Streamlit
77

8+
<Note>
9+
10+
### Skip installation! Community Cloud + GitHub Codespaces
11+
12+
Community Cloud now makes it easy to skip installation and start coding right in your browser with GitHub Codespaces. 🎉 Hop over to our Community Cloud [Quickstart](/streamlit-community-cloud/get-started/quickstart) to create an account, deploy an example app, and jump right into a codespace to start editing. Return to [Main concepts](/library/get-started/main-concepts) to learn all about how Streamlit works.
13+
14+
You can edit any app you've deployed on Community Cloud with GitHub Codespaces. See [Edit your app with GitHub Codespaces](/streamlit-community-cloud/manage-your-app/edit-your-app#edit-your-app-with-github-codespaces).
15+
16+
</Note>
17+
818
## Table of contents
919

1020
1. [Prerequisites](#prerequisites)

content/menu.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,8 @@ site_menu:
443443
url: /streamlit-community-cloud/get-started/connect-your-github-account
444444
- category: Streamlit Community Cloud / Get started / Explore your workspace
445445
url: /streamlit-community-cloud/get-started/explore-your-workspace
446+
- category: Streamlit Community Cloud / Get started / Fork and edit a public app
447+
url: /streamlit-community-cloud/get-started/fork-and-edit-a-public-app
446448
- category: Streamlit Community Cloud / Get started / Trust and Security
447449
url: /streamlit-community-cloud/get-started/trust-and-security
448450
- category: Streamlit Community Cloud / Deploy your app
@@ -459,6 +461,8 @@ site_menu:
459461
url: /streamlit-community-cloud/manage-your-app/app-settings
460462
- category: Streamlit Community Cloud / Manage your app / Delete your app
461463
url: /streamlit-community-cloud/manage-your-app/delete-your-app
464+
- category: Streamlit Community Cloud / Manage your app / Edit your app
465+
url: /streamlit-community-cloud/manage-your-app/edit-your-app
462466
- category: Streamlit Community Cloud / Manage your app / Favorite your app
463467
url: /streamlit-community-cloud/manage-your-app/favorite-your-app
464468
- category: Streamlit Community Cloud / Manage your app / Reboot your app

content/streamlit-cloud/deploy-your-app/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug: /streamlit-community-cloud/deploy-your-app
55

66
# Deploy your app
77

8-
Streamlit Community Cloud lets you deploy your apps in just one click, and most apps will deploy in only a few minutes. If you don't have an app ready to deploy, fork or clone one from our <a href="https://streamlit.io/gallery" target="_blank">App gallery</a> — you can find apps for machine learning, data visualization, data exploration, A/B testing and more.
8+
Streamlit Community Cloud lets you deploy your apps in just one click, and most apps will deploy in only a few minutes. If you don't have an app ready to deploy, fork or clone one from our <a href="https://streamlit.io/gallery" target="_blank">App gallery</a> — you can find apps for machine learning, data visualization, data exploration, A/B testing and more. You can also fork and deploy samples straight from the [New app button](/streamlit-community-cloud/get-started/explore-your-workspace#new-app-button). Once you've deployed your app, check out how you can [Edit your app with GitHub Codespaces](/streamlit-community-cloud/manage-your-app/edit-your-app#edit-your-app-with-github-codespaces).
99

1010
<Note>
1111

@@ -37,27 +37,27 @@ your-repository/
3737

3838
<Important>
3939

40-
Although you can deploy multiple apps from the same repository, there can be only one configuration file.
40+
Although you can deploy multiple apps from the same repository, there can be only one configuration file.
4141

4242
</Important>
4343

4444
## Deploy your app
4545

4646
1. From your workspace at <a href="https://share.streamlit.io" target="_blank">share.streamlit.io</a>, click "**New app**" from the upper-right corner of your workspace.
4747

48-
![Deploy a new app from your workspace](/images/streamlit-community-cloud/deploy-empty-new-app.png)
48+
![Deploy a new app from your workspace](/images/streamlit-community-cloud/deploy-empty-new-app.png)
4949

5050
2. Fill in your repo, branch, and file path. As a shortcut, you can also click "**Paste GitHub URL**" to paste a link directly to `your_app.py` on GitHub.
5151

52-
An app URL with a random hash is prefilled but you can change this to a custom subdomain instead. In the example below, the app would be deployed to `https://red-balloon.streamlit.app/`. You can always change your subdomain later. See more about [Custom subdomains](#custom-subdomains) at the end of this page.
52+
An app URL with a random hash is prefilled but you can change this to a custom subdomain instead. In the example below, the app would be deployed to `https://red-balloon.streamlit.app/`. You can always change your subdomain later. See more about [Custom subdomains](#custom-subdomains) at the end of this page.
5353

54-
![Fill in your app's information to deploy your app](/images/streamlit-community-cloud/deploy-an-app.png)
54+
![Fill in your app's information to deploy your app](/images/streamlit-community-cloud/deploy-an-app.png)
5555

5656
## Advanced settings for deployment
5757

5858
3. (Optional) If you are connecting to a data source or want to specify the Python version for your app, you can do that by clicking "**Advanced settings**" before you deploy the app. Learn more about [Secrets management](/streamlit-community-cloud/deploy-your-app/secrets-management).
5959

60-
![Advanced settings for deploying your app](/images/streamlit-community-cloud/deploy-an-app-advanced.png)
60+
![Advanced settings for deploying your app](/images/streamlit-community-cloud/deploy-an-app-advanced.png)
6161

6262
<Tip>
6363

content/streamlit-cloud/get-started/explore-your-workspace.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,22 @@ If you just [created your account](/streamlit-community-cloud/get-started/create
99

1010
![Your Streamlit Community Cloud workspace](/images/streamlit-community-cloud/workspace-empty.png)
1111

12+
## Switching workspaces
13+
1214
You may also find that you already have access to multiple Streamlit Community Cloud workspaces. Streamlit Community Cloud automatically groups your apps according to the corresponding GitHub repository's owner or organzation. In the upper-right corner you can see the workspaces you have access to. If apps have already been deployed from any of your repositories, then you will see those apps when you select the associated workspace in the upper-right corner. Learn more about how to [Manage your app from your workspace](/streamlit-community-cloud/manage-your-app#manage-your-app-from-your-workspace).
1315

1416
![Switch between your Streamlit Community Cloud workspaces](/images/streamlit-community-cloud/workspace-empty-switch.png)
1517

18+
## New app button
19+
20+
Your workspace is your base of operations to deploy apps and manage them. You can click on "**New app**" to [Deploy your app](/streamlit-community-cloud/deploy-your-app) from a repository where you have administrative privileges. If you want additional options, click the down arrow (<i style={{ verticalAlign: "-.25em" }} className={{ class: "material-icons-sharp" }}>expand_more</i>) to begin with a template.
21+
22+
- "**Use existing repo**" is the default to [Deploy your app](/streamlit-community-cloud/deploy-your-app) from a repository where you have administrative privileges.
23+
- "**Create from sample app template**" will fork and deploy a <a href="https://github.com/streamlit/streamlit-example" target="_blank">simple, one-page Streamlit app</a>.
24+
- "**Create new app with GitHub Codespaces**" will fork and deploy our multipage <a href="https://github.com/streamlit/streamlit-hello" target="_blank">Streamlit Hello</a> app and create a codespace. To jump quickly into GitHub Codespaces for any of your deployed apps, see [Edit your app with GitHub Codespaces](/streamlit-community-cloud/manage-your-app/edit-your-app#edit-your-app-with-github-codespaces) instead.
25+
26+
![Options to deploy a new app from your workspace in Streamlit Community Cloud](/images/streamlit-community-cloud/deploy-menu.png)
27+
1628
## Invite other developers to your workspace
1729

1830
Inviting other developers is simple, just invite them to your GitHub repository so that you can code on apps together, and then have them log in to <a href="https://share.streamlit.io/signup" target="_blank">share.streamlit.io/signup</a>. Read more about connecting to a GitHub organization in [Organization access](/streamlit-community-cloud/get-started/connect-your-github-account#organization-access).
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Fork and edit a public app
3+
slug: /streamlit-community-cloud/get-started/fork-and-edit-a-public-app
4+
---
5+
6+
# Fork and edit a public app
7+
8+
Community Cloud is all about learning, sharing, and exploring the world of Streamlit. For apps with public repositories, you can quickly fork copies to your GitHub account, deploy your own version, and jump into a codespace on GitHub to start editing and exploring Streamlit code &mdash; all in the cloud so you don't have to install anything.
9+
10+
1. From a forkable app, in the upper-right corner, click "<i style={{ verticalAlign: "-.25em" }} className={{ class: "material-icons-sharp" }}>fork_right</i> **Fork this app**."
11+
12+
![Click Fork this app from a public app](/images/streamlit-community-cloud/fork-and-edit.png)
13+
14+
2. Click "**Fork!**" The repository will be forked to your GitHub account. If you have already forked the repository or have another repository of the same name, the fork will fail. In this case, you can manually fork the repository on GitHub, then follow the instructions to [Deploy your app](/streamlit-community-cloud/deploy-your-app#deploy-your-app) and [Edit your app with GitHub Codespaces](/streamlit-community-cloud/manage-your-app/edit-your-app#edit-your-app-with-github-codespaces).
15+
16+
![Click Fork to confirm](/images/streamlit-community-cloud/fork-codespace-1.png)
17+
18+
3. Click "**Create codespace**" to confirm the creation of a codespace on your account. Read more about <a href="https://github.com/features/codespaces" target="_blank">GitHub Codespaces</a> to learn about monthly limits for free use and paid plans.
19+
20+
![Create a codespace on your GitHub account](/images/streamlit-community-cloud/fork-codespace-2.png)
21+
22+
4. Wait for GitHub to set up your codespace.
23+
24+
![GitHub preparing your codespace](/images/streamlit-community-cloud/deploy-codespaces-3.png)
25+
26+
5. GitHub will automatically execute the commands to launch your Streamlit app within your codespace. Your app will be visible in a "Simple Browser" on the right. This may take a minute to complete from when your codespace first appears on screen.
27+
28+
![Your new GitHub Codespace](/images/streamlit-community-cloud/fork-cheatsheet-codespace.png)
29+
30+
You now have a copy the public app deployed from your account. You can edit and explore within your codespace and (if you choose) commit your changes to your deployed app to share with the world! 🌎 Learn more about editing your app in GitHub Codespaces, commiting your edits to your repository, and shutting down your codespace in [Edit your app with GitHub Codespaces](/streamlit-community-cloud/manage-your-app/edit-your-app#edit-your-app-with-github-codespaces).

content/streamlit-cloud/get-started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ First things first, you need to create your Streamlit Community Cloud account to
1313
<Tile
1414
icon="rocket_launch"
1515
title="Quickstart"
16-
text="Create your account and deploy an example app as fast as possible. No frills."
16+
text="Create your account and deploy an example app as fast as possible. Jump right into coding with GitHub Codespaces."
1717
link="/streamlit-community-cloud/get-started/quickstart"
1818
/>
1919
<Tile

0 commit comments

Comments
 (0)