Skip to content

Update Community Cloud docs #766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 47 commits into from
Aug 8, 2023
Merged

Conversation

sfc-gh-dmatthews
Copy link
Contributor

@sfc-gh-dmatthews sfc-gh-dmatthews commented Jul 22, 2023

[WIP]

📚 Context

Since the sunsetting of Enterprise accounts on Streamlit Community Cloud, there remains some language that is out-of-alignment with the current version of Streamlit Community Cloud. This is a general update to bring screenshots and descriptions in line with the current state of affairs.

🧠 Description of Changes

  • Updated sign-up instructions and better explained the difference between primary and source control identities.
  • Removed duplicate images from a prior renaming of public/images/streamlit-cloud to public/images/streamlit-community-cloud
  • Image updates to reflect current UI
  • Removed workspace analytics
  • Rearrangement of navigation
  • Revised app dependencies for clarity
  • Added Community Cloud quickstart
  • Expanded explanation of GitHub authorization both during account creation and managing afterwards
  • Revised and updated Share-your-app instructions
Revised (WIP):
Previous:

💥 Impact

  • Not small

🌐 References

Notion Sprint tasks

closes #740

Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.

Updated Get started page to better describe the accounts used with Streamlit Community Cloud and how to sign up.
This commit duplicate images in public/images/streamlit-cloud that were an artifact of renaming the folder to .../streamlit-community-cloud
Update sign-in instructions and images for consistency
fix: URL mask alignment
More image updates for consistency and better resolution. GitHub connection details moved to a separate page.
Updated Community Cloud documentation to mention there is a pre-filled custom subdomain and that it can be deleted or changed.
Updated custom subdomain images for consistency and resolution.
Improve explanation of `requirements.txt` and `packages.txt`
Make table of Python package managers prettier.
Copy link
Collaborator

@jrieke jrieke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left few comments on the dir structure, rest LGTM. No need for another review.

@@ -17,20 +17,40 @@ If you want to deploy your app on a different cloud service, check out the [Depl

Streamlit Community Cloud launches apps directly from your GitHub repo, so your app code and dependencies need to be on GitHub before you try to deploy the app. See [App dependencies](/streamlit-community-cloud/get-started/deploy-an-app/app-dependencies) for more information.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe turn the last sentence into "For more information on how to specify dependencies, see App dependencies"

Small edits for clarity and from feedback
Move Connect to GitHub out of Community Cloud Get started and make a separate page.
Delete duplicate content from temporary rearrangement.
Removed duplicate index of Connect to data sources tutorials.
Move "Deploy your app", "Share your app", and "Manage your app" to the top level of navigation within Community Cloud. Move Trust and Security to Getting started alongs side connecting to GitHub/GitHub authorization.
Updated instructions to connect to GitHub. Included explanation on authorizing organizations.
Added instructions for connecting and modifying GitHub account permissions after account creation.
Update links from file rearrangement
Rearrange tiles on top-level page for Streamlit Community Cloud.
Move account creation and workspace exploration to their own sub-pages under Get started.
Change to using the built-in sample app deployment from the New App menu instead of manually forking an example app to deploy.
Additional images and edits to document the process of creating a Streamlit Community Cloud account.
Link updates and clarity edits within the pages of Get started in Community Cloud.
Revise language in security-model.md
Move Manage your app to before Share your app. Update Share your app page including updating and adding images.
Modify description of app analytics and create separate page for it. Update and add images.
Create separate page for app favoriting. Update and add images.
Create separate page for rebooting apps. Update and add images.
Create separate page for deleting apps. Update and add images.
Rearrange content to summarize the different places to access menus. Summarize each menu with links to the associated detail pages. Update and add images.
Create separate page for workspace settings as distinct from app settings. Update and add images.
Verify and update links and images from Get started through Manage your app/Workspace settings.
Verify and update links and images within Share your app section.
…tion)

Verify and update links and images within Manage your account section.
Change summary navigation at the top level of Streamlit Community Cloud.
@sfc-gh-dmatthews sfc-gh-dmatthews marked this pull request as ready for review August 8, 2023 22:23
@sfc-gh-dmatthews sfc-gh-dmatthews merged commit 0f9b4cc into main Aug 8, 2023
@sfc-gh-dmatthews sfc-gh-dmatthews deleted the fix/community-cloud-docs-update branch August 8, 2023 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Explain the differences between the email, Google, and GitHub logins for Community Cloud
2 participants