Skip to content

use_article() #281

@jennybc

Description

@jennybc

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docs 💡documentation, news, vignettes, website, etcfeaturea feature request or enhancement

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions