From fb9d66d51db9cff01fb483d79ea269447000ab07 Mon Sep 17 00:00:00 2001 From: Jenny Bryan Date: Tue, 16 Jun 2020 10:36:44 -0700 Subject: [PATCH] Rename files --- _bookdown.yml | 6 +++--- remote-scenarios-unsupported.Rmd | 10 ---------- ...scenarios-supported.Rmd => remote-setups-common.Rmd | 4 ++-- remote-scenarios-intro.Rmd => remote-setups-intro.Rmd | 2 +- remote-setups-peculiar.Rmd | 10 ++++++++++ 5 files changed, 16 insertions(+), 16 deletions(-) delete mode 100644 remote-scenarios-unsupported.Rmd rename remote-scenarios-supported.Rmd => remote-setups-common.Rmd (98%) rename remote-scenarios-intro.Rmd => remote-setups-intro.Rmd (96%) create mode 100644 remote-setups-peculiar.Rmd diff --git a/_bookdown.yml b/_bookdown.yml index f3c58c40..9d7fa0a7 100644 --- a/_bookdown.yml +++ b/_bookdown.yml @@ -40,9 +40,9 @@ rmd_files: [ "git-branches.Rmd", "git-remotes.Rmd", - "remote-scenarios-intro.Rmd", - "remote-scenarios-supported.Rmd", - "remote-scenarios-unsupported.Rmd", + "remote-setups-intro.Rmd", + "remote-setups-common.Rmd", + "remote-setups-peculiar.Rmd", "workflows-intro.Rmd", "workflows-repeated-amend.Rmd", diff --git a/remote-scenarios-unsupported.Rmd b/remote-scenarios-unsupported.Rmd deleted file mode 100644 index 551075ca..00000000 --- a/remote-scenarios-unsupported.Rmd +++ /dev/null @@ -1,10 +0,0 @@ -# Unsupported remote setups {#unsupported} - -Just like the previous section about more favorable setups, we only consider a very constrained set of remotes: - -* The remote is on GitHub. -* The remote is named `origin` or `upstream`. - -This section exists as counterpoint to the previous. Here we provide more details on remote setups that usethis can't work with and suggest improvements. *2020-06 note: this currently refers to features in a development version of usethis. These features are not in v1.6.1 = the current CRAN version.* - -*section coming soon* diff --git a/remote-scenarios-supported.Rmd b/remote-setups-common.Rmd similarity index 98% rename from remote-scenarios-supported.Rmd rename to remote-setups-common.Rmd index 30589467..cc4da1eb 100644 --- a/remote-scenarios-supported.Rmd +++ b/remote-setups-common.Rmd @@ -1,4 +1,4 @@ -# Supported remote setups {#supported} +# Common remote setups {#common-remote-setups} We only consider a very constrained set of remotes here: @@ -98,7 +98,7 @@ This is a less common variation on the fork setup. knitr::include_graphics("img/fork-ours.png") ``` -In this case, you have permission to push to the primary repo, but you elect to create a personal fork anyway. Certain projects favor this approach and it offers maximum development flexibility for advanced users. However, most users are better-served by the simpler "ours" setup in this case. +In this case, you have permission to push to the primary repo, but you elect to create a personal fork anyway. Certain projects favor this approach and it offers maximum development flexibility for advanced users. However, most users are better served by the simpler "ours" setup in this case. `usethis::create_from_github("OWNER/REPO", fork = TRUE)` can create this setup, as long as you have configured a `GITHUB_PAT`. usethis describes this setup as "fork". diff --git a/remote-scenarios-intro.Rmd b/remote-setups-intro.Rmd similarity index 96% rename from remote-scenarios-intro.Rmd rename to remote-setups-intro.Rmd index fbd6aa4f..e6a38853 100644 --- a/remote-scenarios-intro.Rmd +++ b/remote-setups-intro.Rmd @@ -1,4 +1,4 @@ -# (PART) Remote scenarios {-} +# (PART) Remote setups {-} # Git remote setups {#remote-scenarios-intro .unnumbered} diff --git a/remote-setups-peculiar.Rmd b/remote-setups-peculiar.Rmd new file mode 100644 index 00000000..76608866 --- /dev/null +++ b/remote-setups-peculiar.Rmd @@ -0,0 +1,10 @@ +# Peculiar remote setups {#unsupported} + +Just like the previous section about the most common setups, we only consider a very constrained set of remotes: + +* The remote is on GitHub. +* The remote is named `origin` or `upstream`. + +This section exists as counterpoint to the previous. Here we provide more details on remote setups that are more unusual and, usually, not very functional. In general, these are setups usethis cannot work with. We try to suggest a better alterntive in each case. *2020-06 note: this currently refers to features in a development version of usethis. These features are not in v1.6.1 = the current CRAN version.* + +*section coming soon*