add instructions for updating, fixes #1

Author: tarakc02

93-cheat-sheet.Rmd

@@ -1,5 +1,7 @@
 # Cheat Sheet {#cheat-sheet}
 
+If you're looking for help installing the discovery engine, head over to the [installation guide](#installation). If you've previously installed the discovery engine, but need to update to the latest version, check the [instructions for updating](#updating).
+
 ## General
 
 * Always start a session with `library(discoveryengine)`

95-updating.Rmd

@@ -0,0 +1,37 @@
+# Updating your installation {#updating}
+
+## When do I need to update the Disco Engine?
+
+We are always working on and improving the Disco Engine, incorporating feedback and adding new features. But you shouldn't feel pressure to be constantly updating your version of the Disco Engine - most updates incorporate new features without disrupting any existing functionality. So when should you update?
+
+1. If a significant bug was discovered and fixed. Tarak will send out an email if this happens.
+2. If a new version includes significantly new functionality, you'll want to update to take advantage of the new features. Tarak will send out an email if this is the case, and there will also be a demonstration of the new features in a staff meeting. 
+3. If you're trying to use a widget you heard about, but you get an error, that's probably because the widget was added since your last update. 
+
+That said, it doesn't take much time to update the Disco Engine (see below for instructions), and updates will never change existing functionality, so feel free to update more frequently if you wish. In fact, if you try to update but you're already on the latest version, you'll get a message informing you of the fact, and no updates will happen. There is no penalty or cost for trying to update the Disco Engine.
+
+## What version am I using right now?
+
+Whenever you start up the Disco Engine, there is a welcome message that will tell you what version number you currently have installed:
+
+![The startup message shows you what version you're using](images/startup-msg.png)
+
+## What's the most recent version?
+
+The welcome message above includes a link to the Disco Engine [NEWS page](https://github.com/tarakc02/discoveryengine/blob/master/NEWS.md), which not only shows what the most recent version number is, but also goes over all of the changes made in each version. 
+
+## How do I update?
+
+We've found that updating goes most smoothly when you start with a fresh R session. So if you already have RStudio open, press Ctrl+Shift+F10 (or use the menu and navigate to Session | Restart R). This will restart R without restarting RStudio. Next, just type:
+
+```{r, eval = FALSE}
+devtools::install_github("tarakc02/discoveryengine")
+```
+
+That should do it! The `devtools` package that is used to do the installation is smart enough to make any other necessary updates to other packages that `discoveryengine` depends on, so typing that one line might result in updates to several packages. 
+
+When you do that, one of these things will happen:
+
+1. You see a message that starts with "Skipping install of 'discoveryengine' from a github remote . . .": That just means you're already up-to-date and don't need to do anything more.
+2. A bunch of text scrolls up the screen, ending with "* DONE (discoveryengine)". Congrats! You've successfully updated your Disco Engine installation!
+3. Something else: uh oh - something might have gone wrong. Get in touch with Tarak or Caleb to help troubleshoot.

docs/add-on-packages.html

@@ -202,17 +202,23 @@
 <li class="chapter" data-level="B.4" data-path="cheat-sheet.html"><a href="cheat-sheet.html#text-search"><i class="fa fa-check"></i><b>B.4</b> Text search</a></li>
 <li class="chapter" data-level="B.5" data-path="cheat-sheet.html"><a href="cheat-sheet.html#other"><i class="fa fa-check"></i><b>B.5</b> Other</a></li>
 </ul></li>
-<li class="chapter" data-level="C" data-path="how-it-works.html"><a href="how-it-works.html"><i class="fa fa-check"></i><b>C</b> How does it work?</a><ul>
-<li class="chapter" data-level="C.1" data-path="how-it-works.html"><a href="how-it-works.html#a-widget-as-a-sql-template"><i class="fa fa-check"></i><b>C.1</b> A Widget as a SQL template</a></li>
-<li class="chapter" data-level="C.2" data-path="how-it-works.html"><a href="how-it-works.html#a-template-as-a-data-structure"><i class="fa fa-check"></i><b>C.2</b> A template as a data structure</a></li>
-<li class="chapter" data-level="C.3" data-path="how-it-works.html"><a href="how-it-works.html#non-standard-evaluation"><i class="fa fa-check"></i><b>C.3</b> Non-standard evaluation</a></li>
-<li class="chapter" data-level="C.4" data-path="how-it-works.html"><a href="how-it-works.html#combining-simple-definitions"><i class="fa fa-check"></i><b>C.4</b> Combining simple definitions</a><ul>
-<li class="chapter" data-level="C.4.1" data-path="how-it-works.html"><a href="how-it-works.html#atomic-vs.-complex-definitions"><i class="fa fa-check"></i><b>C.4.1</b> “Atomic” vs. “Complex” definitions</a></li>
-<li class="chapter" data-level="C.4.2" data-path="how-it-works.html"><a href="how-it-works.html#operations-on-definitions"><i class="fa fa-check"></i><b>C.4.2</b> Operations on definitions</a></li>
+<li class="chapter" data-level="C" data-path="updating.html"><a href="updating.html"><i class="fa fa-check"></i><b>C</b> Updating your installation</a><ul>
+<li class="chapter" data-level="C.1" data-path="updating.html"><a href="updating.html#when-do-i-need-to-update-the-disco-engine"><i class="fa fa-check"></i><b>C.1</b> When do I need to update the Disco Engine?</a></li>
+<li class="chapter" data-level="C.2" data-path="updating.html"><a href="updating.html#what-version-am-i-using-right-now"><i class="fa fa-check"></i><b>C.2</b> What version am I using right now?</a></li>
+<li class="chapter" data-level="C.3" data-path="updating.html"><a href="updating.html#whats-the-most-recent-version"><i class="fa fa-check"></i><b>C.3</b> What’s the most recent version?</a></li>
+<li class="chapter" data-level="C.4" data-path="updating.html"><a href="updating.html#how-do-i-update"><i class="fa fa-check"></i><b>C.4</b> How do I update?</a></li>
 </ul></li>
-<li class="chapter" data-level="C.5" data-path="how-it-works.html"><a href="how-it-works.html#re-visiting-to_sql"><i class="fa fa-check"></i><b>C.5</b> Re-visiting <code>to_sql</code></a></li>
-<li class="chapter" data-level="C.6" data-path="how-it-works.html"><a href="how-it-works.html#seeing-it-all-in-action"><i class="fa fa-check"></i><b>C.6</b> Seeing it all in action</a></li>
-<li class="chapter" data-level="C.7" data-path="how-it-works.html"><a href="how-it-works.html#for-further-study"><i class="fa fa-check"></i><b>C.7</b> For further study</a></li>
+<li class="chapter" data-level="D" data-path="how-it-works.html"><a href="how-it-works.html"><i class="fa fa-check"></i><b>D</b> How does it work?</a><ul>
+<li class="chapter" data-level="D.1" data-path="how-it-works.html"><a href="how-it-works.html#a-widget-as-a-sql-template"><i class="fa fa-check"></i><b>D.1</b> A Widget as a SQL template</a></li>
+<li class="chapter" data-level="D.2" data-path="how-it-works.html"><a href="how-it-works.html#a-template-as-a-data-structure"><i class="fa fa-check"></i><b>D.2</b> A template as a data structure</a></li>
+<li class="chapter" data-level="D.3" data-path="how-it-works.html"><a href="how-it-works.html#non-standard-evaluation"><i class="fa fa-check"></i><b>D.3</b> Non-standard evaluation</a></li>
+<li class="chapter" data-level="D.4" data-path="how-it-works.html"><a href="how-it-works.html#combining-simple-definitions"><i class="fa fa-check"></i><b>D.4</b> Combining simple definitions</a><ul>
+<li class="chapter" data-level="D.4.1" data-path="how-it-works.html"><a href="how-it-works.html#atomic-vs.-complex-definitions"><i class="fa fa-check"></i><b>D.4.1</b> “Atomic” vs. “Complex” definitions</a></li>
+<li class="chapter" data-level="D.4.2" data-path="how-it-works.html"><a href="how-it-works.html#operations-on-definitions"><i class="fa fa-check"></i><b>D.4.2</b> Operations on definitions</a></li>
+</ul></li>
+<li class="chapter" data-level="D.5" data-path="how-it-works.html"><a href="how-it-works.html#re-visiting-to_sql"><i class="fa fa-check"></i><b>D.5</b> Re-visiting <code>to_sql</code></a></li>
+<li class="chapter" data-level="D.6" data-path="how-it-works.html"><a href="how-it-works.html#seeing-it-all-in-action"><i class="fa fa-check"></i><b>D.6</b> Seeing it all in action</a></li>
+<li class="chapter" data-level="D.7" data-path="how-it-works.html"><a href="how-it-works.html#for-further-study"><i class="fa fa-check"></i><b>D.7</b> For further study</a></li>
 </ul></li>
 <li class="divider"></li>
 <li><a href="https://github.com/rstudio/bookdown" target="blank">Published with bookdown</a></li>

docs/brainstorm-bot.html

@@ -202,17 +202,23 @@
 <li class="chapter" data-level="B.4" data-path="cheat-sheet.html"><a href="cheat-sheet.html#text-search"><i class="fa fa-check"></i><b>B.4</b> Text search</a></li>
 <li class="chapter" data-level="B.5" data-path="cheat-sheet.html"><a href="cheat-sheet.html#other"><i class="fa fa-check"></i><b>B.5</b> Other</a></li>
 </ul></li>
-<li class="chapter" data-level="C" data-path="how-it-works.html"><a href="how-it-works.html"><i class="fa fa-check"></i><b>C</b> How does it work?</a><ul>
-<li class="chapter" data-level="C.1" data-path="how-it-works.html"><a href="how-it-works.html#a-widget-as-a-sql-template"><i class="fa fa-check"></i><b>C.1</b> A Widget as a SQL template</a></li>
-<li class="chapter" data-level="C.2" data-path="how-it-works.html"><a href="how-it-works.html#a-template-as-a-data-structure"><i class="fa fa-check"></i><b>C.2</b> A template as a data structure</a></li>
-<li class="chapter" data-level="C.3" data-path="how-it-works.html"><a href="how-it-works.html#non-standard-evaluation"><i class="fa fa-check"></i><b>C.3</b> Non-standard evaluation</a></li>
-<li class="chapter" data-level="C.4" data-path="how-it-works.html"><a href="how-it-works.html#combining-simple-definitions"><i class="fa fa-check"></i><b>C.4</b> Combining simple definitions</a><ul>
-<li class="chapter" data-level="C.4.1" data-path="how-it-works.html"><a href="how-it-works.html#atomic-vs.-complex-definitions"><i class="fa fa-check"></i><b>C.4.1</b> “Atomic” vs. “Complex” definitions</a></li>
-<li class="chapter" data-level="C.4.2" data-path="how-it-works.html"><a href="how-it-works.html#operations-on-definitions"><i class="fa fa-check"></i><b>C.4.2</b> Operations on definitions</a></li>
+<li class="chapter" data-level="C" data-path="updating.html"><a href="updating.html"><i class="fa fa-check"></i><b>C</b> Updating your installation</a><ul>
+<li class="chapter" data-level="C.1" data-path="updating.html"><a href="updating.html#when-do-i-need-to-update-the-disco-engine"><i class="fa fa-check"></i><b>C.1</b> When do I need to update the Disco Engine?</a></li>
+<li class="chapter" data-level="C.2" data-path="updating.html"><a href="updating.html#what-version-am-i-using-right-now"><i class="fa fa-check"></i><b>C.2</b> What version am I using right now?</a></li>
+<li class="chapter" data-level="C.3" data-path="updating.html"><a href="updating.html#whats-the-most-recent-version"><i class="fa fa-check"></i><b>C.3</b> What’s the most recent version?</a></li>
+<li class="chapter" data-level="C.4" data-path="updating.html"><a href="updating.html#how-do-i-update"><i class="fa fa-check"></i><b>C.4</b> How do I update?</a></li>
 </ul></li>
-<li class="chapter" data-level="C.5" data-path="how-it-works.html"><a href="how-it-works.html#re-visiting-to_sql"><i class="fa fa-check"></i><b>C.5</b> Re-visiting <code>to_sql</code></a></li>
-<li class="chapter" data-level="C.6" data-path="how-it-works.html"><a href="how-it-works.html#seeing-it-all-in-action"><i class="fa fa-check"></i><b>C.6</b> Seeing it all in action</a></li>
-<li class="chapter" data-level="C.7" data-path="how-it-works.html"><a href="how-it-works.html#for-further-study"><i class="fa fa-check"></i><b>C.7</b> For further study</a></li>
+<li class="chapter" data-level="D" data-path="how-it-works.html"><a href="how-it-works.html"><i class="fa fa-check"></i><b>D</b> How does it work?</a><ul>
+<li class="chapter" data-level="D.1" data-path="how-it-works.html"><a href="how-it-works.html#a-widget-as-a-sql-template"><i class="fa fa-check"></i><b>D.1</b> A Widget as a SQL template</a></li>
+<li class="chapter" data-level="D.2" data-path="how-it-works.html"><a href="how-it-works.html#a-template-as-a-data-structure"><i class="fa fa-check"></i><b>D.2</b> A template as a data structure</a></li>
+<li class="chapter" data-level="D.3" data-path="how-it-works.html"><a href="how-it-works.html#non-standard-evaluation"><i class="fa fa-check"></i><b>D.3</b> Non-standard evaluation</a></li>
+<li class="chapter" data-level="D.4" data-path="how-it-works.html"><a href="how-it-works.html#combining-simple-definitions"><i class="fa fa-check"></i><b>D.4</b> Combining simple definitions</a><ul>
+<li class="chapter" data-level="D.4.1" data-path="how-it-works.html"><a href="how-it-works.html#atomic-vs.-complex-definitions"><i class="fa fa-check"></i><b>D.4.1</b> “Atomic” vs. “Complex” definitions</a></li>
+<li class="chapter" data-level="D.4.2" data-path="how-it-works.html"><a href="how-it-works.html#operations-on-definitions"><i class="fa fa-check"></i><b>D.4.2</b> Operations on definitions</a></li>
+</ul></li>
+<li class="chapter" data-level="D.5" data-path="how-it-works.html"><a href="how-it-works.html#re-visiting-to_sql"><i class="fa fa-check"></i><b>D.5</b> Re-visiting <code>to_sql</code></a></li>
+<li class="chapter" data-level="D.6" data-path="how-it-works.html"><a href="how-it-works.html#seeing-it-all-in-action"><i class="fa fa-check"></i><b>D.6</b> Seeing it all in action</a></li>
+<li class="chapter" data-level="D.7" data-path="how-it-works.html"><a href="how-it-works.html#for-further-study"><i class="fa fa-check"></i><b>D.7</b> For further study</a></li>
 </ul></li>
 <li class="divider"></li>
 <li><a href="https://github.com/rstudio/bookdown" target="blank">Published with bookdown</a></li>