Skip to content
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.

Sign up for GitHub

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

Jump to bottom

How to Deploy a Shiny App.md #45

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

How to Deploy a Shiny App.md #45

wants to merge 13 commits into from

Conversation

rmccreath
Copy link
Member

@rmccreath rmccreath commented Aug 7, 2023 •
edited
Loading

Pull Request Details

Issue Number: Closes #44

Type: Documentation

Description of the Change

Adding guidance for Shiny deployment to sit alongside other 'information sharing' content, covering key considerations for sharing and the deployment process for Shiny apps onto shinyapps.io.

Release Notes

  • Added Shiny app deployment guidance

@rmccreath rmccreath added the documentation Improvements or additions to documentation label Aug 7, 2023
@rmccreath rmccreath self-assigned this Aug 7, 2023
@rmccreath rmccreath changed the title Draft Publish a Shiny App.md Draft - Publish a Shiny App.md Aug 8, 2023
Moohan
Moohan reviewed Dec 12, 2023
View reviewed changes
Shiny/Publish a Shiny App.md Outdated Show resolved Hide resolved
Shiny/Publish a Shiny App.md Outdated Show resolved Hide resolved
Shiny/Publish a Shiny App.md Outdated Show resolved Hide resolved
Shiny/Publish a Shiny App.md Outdated Show resolved Hide resolved
Shiny/Publish a Shiny App.md Outdated Show resolved Hide resolved
@rmccreath rmccreath changed the title Draft - Publish a Shiny App.md How to Deploy a Shiny App.md Oct 2, 2024
@rmccreath
Copy link
Member Author

Feedback from @juliaromero-phs

Deploying a Shiny app

  1. Deploying a Shiny app - Mention that the code mentioned should sit in a separate script and just needs to be ran like a "normal" script to deploy.
  2. Troubleshooting - If dashboard doesn't deploy, Profile code using the profvis package
  3. Troubleshooting - If a dashboard is large, and code has been optimised with profiling, the dashboard might need more memory on the Shiny server.

@rmccreath
Copy link
Member Author

@juliaromero-phs

  1. Updated the text to describe purpose and not to include within the app codebase.
  2. Great suggestion, added in for troubleshooting.
  3. I think keeping the final statement as getting in touch with other users/admins will prevent users from defaulting to more memory as the solution. It's a limited resource available and gives admins space to ensure performance is covered.

Thanks again for your feedback. Could you review again/approve if you think it's ready for sharing?

JFix89
JFix89 requested changes Nov 5, 2024
View reviewed changes
Copy link
Contributor

@JFix89 JFix89 left a comment

Choose a reason for hiding this comment

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

Also looks good to me overall, thanks again!

Information Sharing/Deploying a Shiny App.md Outdated Show resolved Hide resolved
@rmccreath rmccreath requested review from JFix89 and Moohan November 7, 2024 10:29
@rmccreath rmccreath requested a review from Moohan November 7, 2024 13:58
Moohan
Moohan approved these changes Nov 7, 2024
View reviewed changes
Copy link
Member

@Moohan Moohan left a comment

Choose a reason for hiding this comment

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

I sent a message to Russell about naming conventions and how that might link up in a Posit Connect future but it's more something to think about, not a change to be made here.

Happy with this as far as I can see - Note I have never used the PHS Shiny app deployment process, it would be good to have at least one person who has to review this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@monicamcgibbon monicamcgibbon monicamcgibbon approved these changes

@JFix89 JFix89 JFix89 approved these changes

@Moohan Moohan Moohan approved these changes

Assignees

@rmccreath rmccreath

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

REQ - Add Shiny deployment guidance
4 participants
@rmccreath @Moohan @JFix89 @monicamcgibbon