ThinkR-open / ThinkR-open/golem

More documentation for deploying on Shiny Server

Open
#698 1 comment 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Difficulty: intermediate documentation effort: medium hacktoberfest
Dominant language
R
Stars
945
Forks
136
PR merge metrics
No merged PRs in 30d

Description

I really appreciate the work that has been done on golem. It is a life-saver for building large packages.

This is a request for more documentation/examples when deploying to Shiny Server with Docker. I have found some documentation using Docker with Shiny Server, but nothing specific to golem. This process is made a bit more complicated due to how golem structures the server.R and ui.R.

There's one Stack Overflow post that I'm using as an example: https://stackoverflow.com/questions/66095119/looking-for-help-launching-a-dockerized-shiny-app-built-with-the-golem-framework

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing golem's server.R and ui.R structure alongside the linked Stack Overflow example for Dockerized Shiny Server deployment. Document a golem-specific deployment example and explain how the server.R and ui.R structure is handled; the documentation is done when a reader can follow it to deploy a golem app on Shiny Server with Docker.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, r
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.