Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

user alerts for use_pkgdown() #1865

Closed
wants to merge 1 commit into from

Conversation

jayhesselberth
Copy link
Contributor

use_pkgdown() is recommended in the pkgdown README so many are probably using. more feedback might reduce surprises later on (e.g., not realizing docs/ was git-ignored.)

r-lib/pkgdown#2087

`use_pkgdown()` is recommended in the pkgdown README so many are probably using. more feedback might reduce surprises later on (e.g., not realizing `docs/` was git-ignored.)

r-lib/pkgdown#2087
@jayhesselberth
Copy link
Contributor Author

We might also consider prompting the user to ask whether they intend to use docs/ directory or the gh-pages branch on GitHub Pages. If the former, then we shouldn't git-ignore docs/

@jennybc
Copy link
Member

jennybc commented Jun 23, 2023

use_pkgdown() already emits all of these messages:

devtools::load_all("~/rrr/usethis")
#> ℹ Loading usethis

create_local_package()
#> ✔ Setting active project to '/private/tmp/Rtmpdm53vZ/testpkg36bfc716496'
use_pkgdown()
#> ✔ Adding '^_pkgdown\\.yml$', '^docs$', '^pkgdown$' to '.Rbuildignore'
#> ✔ Adding 'docs' to '.gitignore'
#> ✔ Writing '_pkgdown.yml'
#> • Edit '_pkgdown.yml'

Created on 2023-06-23 with reprex v2.0.2.9000

I suspect that a better baseline recommendation in pkgdown is usethis::use_pkgdown_github_pages().

@jennybc jennybc closed this Jun 23, 2023
jennybc added a commit that referenced this pull request Jun 23, 2023
Inspired by investigating #1865
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants