From f1609032332424980633650bbe37454f3171a6e0 Mon Sep 17 00:00:00 2001
From: Leonardo Collado Torres <lcolladotor@gmail.com>
Date: Wed, 5 Feb 2020 09:59:16 -0500
Subject: [PATCH] Expand the deploy_site_github() documentation to resolve
 https://github.com/r-lib/pkgdown/issues/1206

---
 R/deploy-site.R           | 4 ++++
 man/deploy_site_github.Rd | 8 ++++++--
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/R/deploy-site.R b/R/deploy-site.R
index c217faf76..95769bc8b 100644
--- a/R/deploy-site.R
+++ b/R/deploy-site.R
@@ -46,6 +46,10 @@
 #'    ```yaml
 #'    url: http://pkgdown.r-lib.org
 #'    ```
+#' * If needed, on your `.travis.yml` file, specify the `ssh_id` on your call
+#' to `deploy_site_github()`. For example,
+#' `ssh_id = Sys.getenv("TRAVIS_DEPLOY_KEY", "")`. Check the Travis logs to
+#' find the environment variable name used for storing the deployment ssh key.
 #'
 #' @inheritParams build_site
 #' @param install Optionally, opt-out of automatic installation. This is
diff --git a/man/deploy_site_github.Rd b/man/deploy_site_github.Rd
index 64dd86692..856e7ae51 100644
--- a/man/deploy_site_github.Rd
+++ b/man/deploy_site_github.Rd
@@ -20,7 +20,7 @@ deploy_site_github(
 \item{pkg}{Path to package.}
 
 \item{install}{Optionally, opt-out of automatic installation. This is
-necessary if the package you're document is a dependency of pkgdown}
+necessary if the package you're documenting is a dependency of pkgdown}
 
 \item{tarball}{The location of the built package tarball. The default Travis
 configuration for R packages sets \code{PKG_TARBALL} to this path.}
@@ -60,7 +60,7 @@ deploy:
 }
 \item Then you will need to setup your deployment keys. The easiest way is to call
 \code{travis::use_travis_deploy()}. This will generate and push the necessary
-keys to your GitHub and Travis accounts. See the \href{https://ropenscilabs.github.io/travis/}{travis package website} for more details.
+keys to your GitHub and Travis accounts. See the \href{https://docs.ropensci.org/travis/index.html}{travis package website} for more details.
 \item Next, make sure that a gh-pages branch exists. The simplest way to do
 so is to run the following git commands locally:\preformatted{git checkout --orphan gh-pages
 git rm -rf .
@@ -75,6 +75,10 @@ re-creating them.
 \item If you're using a custom CNAME, make sure you have set the \code{url} in
 \verb{_pkgdown.yaml}:\if{html}{\out{<div class="yaml">}}\preformatted{url: http://pkgdown.r-lib.org
 }\if{html}{\out{</div>}}
+\item If needed, on your \code{.travis.yml} file, specify the \code{ssh_id} on your call
+to \code{deploy_site_github()}. For example,
+\code{ssh_id = Sys.getenv("TRAVIS_DEPLOY_KEY", "")}. Check the Travis logs to
+find the environment variable name used for storing the deployment ssh key.
 }
 }