Dev 1026 (#1081)

* Fix 1026 (#1064) * docs: link to golemverse for external resources The "Example Apps" section on the golemverse page is missing, so I kept it there for as a level two header (in case one wants to copy it to the golemvsere page). * docs: move sections with relevant content for the user to the top I. user preferences in terms of priority (more or less ...) probably 1. Installation 2. New project creation 3. Every day workflow 4. Additional resources 5. Meta info such as about (golem version/code coverage), CoC, how to contribute etc. II. developer preference in terms of priority (more or less ...) probably 1. Meta info in the "About" section golem version/code coverage 2. the rest from above Though I'd prefer the current ordering myself it might be a wise choice to change it towards the user, but that's a matter of taste. Fix some typos and markdown styling. --------- Co-authored-by: vincent guyader <[email protected]> * chore update README fix #1026 --------- Co-authored-by: Ilya Zarubin <[email protected]>
ThinkR-open · Aug 8, 2023 · ebcfe13 · ebcfe13
1 parent d17e0d5
commit ebcfe13
Show file tree

Hide file tree

Showing 2 changed files with 158 additions and 236 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -25,81 +25,71 @@ knitr::opts_chunk$set(
 
 `{golem}` is an opinionated framework for building production-grade shiny applications.
 
-## About
-
-You're reading the doc about version : `r pkgload::pkg_version()`
+## Installation
 
-This README has been compiled on the
+- You can install the stable version from CRAN with:
 
-```{r}
-Sys.time()
+``` r
+install.packages("golem")
 ```
 
-Here are the test & coverage results :
+- You can install the development version from [GitHub](https://github.com/Thinkr-open/golem) with:
 
-```{r}
-devtools::check(quiet = TRUE)
+``` r
+# install.packages("remotes")
+remotes::install_github("Thinkr-open/golem") # very close to CRAN version
+# remotes::install_github("Thinkr-open/golem@dev") # if you like to play
 ```
 
-```{r echo = FALSE}
-unloadNamespace("golem")
-```
+## Resources
 
-```{r}
-covr::package_coverage()
-```
+The `{golem}` package is part of the [`{golemverse}`](https://golemverse.org/), a series of tools for Shiny.
+A list of various `{golem}` related resources (tutorials, video, blog post,...) can be found [here](https://golemverse.org/resources/).
 
-## Tool series
 
-This package is part of a series of tools for Shiny, which includes:
+## Launch the project
 
-- `{golem}` - <https://github.com/ThinkR-open/golem>
-- `{shinipsum}` - <https://github.com/ThinkR-open/shinipsum>
-- `{fakir}` - <https://github.com/ThinkR-open/fakir>
-- `{gemstones}` - <https://github.com/ThinkR-open/gemstones>
+Create a new package with the project template:
 
-## Resources
+```{r, echo=FALSE, out.width="80%", eval=TRUE}
+knitr::include_graphics("https://raw.githubusercontent.com/ThinkR-open/golem/master/inst/img/golemtemplate.png")
+```
 
-### The Book :
+## Step by step guide
 
-- <https://engineering-shiny.org/>
+See full documentation in the `{pkgdown}` website:
 
-- [paper version of the book “Engineering Production-Grade Shiny Apps”](https://www.routledge.com/Engineering-Production-Grade-Shiny-Apps/Fay-Rochette-Guyader-Girard/p/book/9780367466022)
+[CRAN] <https://thinkr-open.github.io/golem/>
 
-### Blog posts :
+[dev] <https://thinkr-open.github.io/golem/dev/>
 
-*Building Big Shiny Apps*
+After project creation, you'll land on `dev/01_start.R`. There are also `dev/02_dev.R` and `dev/03_deploy.R`
 
-- Part 1: <https://rtask.thinkr.fr/building-big-shiny-apps-a-workflow-1/>
-- Part 2: <https://rtask.thinkr.fr/building-big-shiny-apps-a-workflow-2/>
+These files are used to keep a track of all the steps you'll be following while building your app.
 
-[*Make a Fitness App from scratch*](https://towardsdatascience.com/production-grade-r-shiny-with-golem-prototyping-51b03f37c2a9)
+### Step 1 : Getting Started
 
-### Slide decks
+Read [the Getting Started](https://thinkr-open.github.io/golem/articles/a_start.html) Vignette for a detailed walkthrough.
 
-- useR! 2019 : [A Framework for Building Robust & Production Ready Shiny Apps](https://github.com/VincentGuyader/user2019/raw/master/golem_Vincent_Guyader_USER!2019.pdf)
-- ThinkR x RStudio Roadshow,Paris : [Production-grade Shiny Apps with {golem}](https://speakerdeck.com/colinfay/production-grade-shiny-apps-with-golem)
-- rstudio::conf(2020) : [Production-grade Shiny Apps with golem](https://speakerdeck.com/colinfay/rstudio-conf-2020-production-grade-shiny-apps-with-golem)
-- barcelonar (2019-12-03) : [Engineering Production-Grade Shiny Apps with
-{golem}](https://www.barcelonar.org/presentations/BarcelonaR_Building_Production_Grade_Shiny_Apps_with_golem.pdf)
+### Step 2 : Day to Day Dev
 
-### Video
+Read [Day to Day Dev](https://thinkr-open.github.io/golem/articles/b_dev.html) Vignette for a detailed walkthrough.
 
-- [{golem} and Effective Shiny Development Methods](https://www.youtube.com/watch?v=OU1-CkSVdTI)
-- [Hands-on demonstration of {golem}](https://www.youtube.com/watch?v=3-p9XLvoJV0)
-- useR! 2019 : [A Framework for Building Robust & Production Ready Shiny Apps](https://youtu.be/tCAan6smrjs)
-- `r emo::flag("France")` [Introduction to {golem}](https://youtu.be/6qI4NzxlAFU)
-- rstudio::conf(2020) : [Production-grade Shiny Apps with golem](https://posit.co/resources/videos/production-grade-shiny-apps-with-golem/)
-- `r emo::flag("France")` Rencontres R 2021 : [ Conception d'applications Shiny avec {golem}](https://www.youtube.com/watch?v=0f5Me1PFGDs)
-- `r emo::flag("France")` [ Déploiement d'une application {shiny} dans docker avec {renv} et {golem}](https://www.youtube.com/watch?v=diCG4t76k78)
-- `r emo::flag("France")` Rencontres R 2023 : [ {golem} et {fusen}, construire des apps Shiny robustes et faciles à maintenir](https://www.youtube.com/watch?v=cYKsYBFIpX0)
+### Step 3: deploy
 
+Read [Deploying Apps with {golem}](https://thinkr-open.github.io/golem/articles/c_deploy.html) Vignette for a detailed walkthrough.
 
-### Cheatsheet
 
-- [{golem} cheatsheet](https://thinkr.fr/golem_cheatsheet_v0.1.pdf)
+## Tool series
 
-### Examples apps
+This package is part of a series of tools for Shiny, which includes:
+
+- `{golem}` - <https://github.com/ThinkR-open/golem>
+- `{shinipsum}` - <https://github.com/ThinkR-open/shinipsum>
+- `{fakir}` - <https://github.com/ThinkR-open/fakir>
+- `{gemstones}` - <https://github.com/ThinkR-open/gemstones>
+
+## Examples apps
 
 These are examples from the community. Please note that they may not necessarily be written in a canonical fashion and may have been written with different versions of `{golem}` or `{shiny}`.
 
@@ -113,52 +103,29 @@ You can also find apps at:
 - <https://connect.thinkr.fr/connect/>
 - <https://github.com/ColinFay/golemexamples>
 
-## Installation
-
-- You can install the stable version from CRAN with:
+## About
 
-``` r
-install.packages("golem")
-```
+You're reading the doc about version: `r pkgload::pkg_version()`
 
-- You can install the development version from [GitHub](https://github.com/Thinkr-open/golem) with:
+This `README` has been compiled on the
 
-``` r
-# install.packages("remotes")
-remotes::install_github("Thinkr-open/golem")
+```{r}
+Sys.time()
 ```
 
-## Launch the project
-
-Create a new package with the project template:
+Here are the test & coverage results:
 
-```{r, echo=FALSE, out.width="80%", eval=TRUE}
-knitr::include_graphics("https://raw.githubusercontent.com/ThinkR-open/golem/master/inst/img/golemtemplate.png")
+```{r}
+devtools::check(quiet = TRUE)
 ```
 
-## Step by step guide
-
-See full documentation in the {pkgdown} website:
-
-[CRAN] <https://thinkr-open.github.io/golem/>
-
-[dev] <https://thinkr-open.github.io/golem/dev/>
-
-After project creation, you'll land on `dev/01_start.R`. There are also `dev/02_dev.R` and `dev/03_deploy.R`
-
-These files are used to keep a track of all the steps you'll be following while building your app.
-
-### Step 1 : Getting Started
-
-Read [the Getting Started](https://thinkr-open.github.io/golem/articles/a_start.html) Vignette for a detailed walkthrough.
-
-### Step 2 : Day to Day Dev
-
-Read [Day to Day Dev](https://thinkr-open.github.io/golem/articles/b_dev.html) Vignette for a detailed walkthrough.
-
-### Step 3: deploy
+```{r echo = FALSE}
+unloadNamespace("golem")
+```
 
-Read [Deploying Apps with {golem}](https://thinkr-open.github.io/golem/articles/c_deploy.html) Vignette for a detailed walkthrough.
+```{r}
+covr::package_coverage()
+```
 
 ## CoC