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

use_article() #281

Closed
jennybc opened this issue Feb 22, 2018 · 3 comments
Closed

use_article() #281

jennybc opened this issue Feb 22, 2018 · 3 comments

Comments

@jennybc
Copy link
Member

@jennybc jennybc commented Feb 22, 2018

We need use_article() which is a minor variant on use_vignette().

What's wrong with using use_vignette() to create an article?

  1. If you only have articles, you want to Rbuildignore the directory that contains them. So either vignettes/ or vignettes/articles/.
  2. Creation of an article should never trigger an edit to DESCRIPTION. Specifically, do not add a VignetteBuilder field.
  3. The article itself should not have a vignettes: section in the yaml header.

To see me recovering from all of the above mistakes, look at these travis ci reports:

https://travis-ci.org/r-lib/usethis/builds/344519915

https://travis-ci.org/r-lib/usethis/builds/345021574

https://travis-ci.org/r-lib/usethis/builds/345023872

@hadley
Copy link
Member

@hadley hadley commented Nov 30, 2018

1 feels a bit tricky to me (what if you want a mix of articles and vignettes) so I'm just going to do 2 and 3.

@hadley
Copy link
Member

@hadley hadley commented Nov 30, 2018

I'm pretty sure we should still add rmarkdown to Suggests, just to ensure that it's always installed on travis (it probably is because pkgdown imports it, but better to be explicit here, I think)

@hadley
Copy link
Member

@hadley hadley commented Nov 30, 2018

Oh I can just ignore articles by default.

@hadley hadley closed this in a478736 Nov 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants