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

Don't include getting started article in check #2150

Closed
cromanpa94 opened this issue Jun 30, 2022 · 3 comments · Fixed by #2161
Closed

Don't include getting started article in check #2150

cromanpa94 opened this issue Jun 30, 2022 · 3 comments · Fixed by #2161
Labels
articles ✍️ bug an unexpected problem or unintended behavior
Milestone

Comments

@cromanpa94
Copy link

Hi folks,

I'm developing an R package (phruta) that uses your (amazing!!) package to deploy a website of my vignettes. Everything works great locally (i.e. using build_site()). However, I'm not able to pass the relevant checks in github due to an error with build_site_github_pages(). The issue is related to my "Get started" site, which is based on phruta.Rmd:

-- Building articles -----------------------------------------------------------
Error in `data_articles_index()`:
! Vignettes missing from index: phruta

Do you know how I can solve this problem? Thanks in advance for your advice!!

@cromanpa94 cromanpa94 changed the title build_site() vs build_site_github_pages() Error when using build_site_github_pages() vs build_site() Jun 30, 2022
@hadley hadley added bug an unexpected problem or unintended behavior articles ✍️ labels Jun 30, 2022
@hadley
Copy link
Member

hadley commented Jun 30, 2022

This is a bug — I think the easiest way to work around it in the interim is to add it to the articles index.

@cromanpa94
Copy link
Author

Sounds good! Thanks @hadley!!

@hadley hadley changed the title Error when using build_site_github_pages() vs build_site() Don't include getting started article in check Jul 10, 2022
@hadley hadley added this to the v2.0.6 milestone Jul 12, 2022
@olivroy
Copy link
Collaborator

olivroy commented Apr 13, 2024

Will open a new issue, but this could leverage pkgdown:::article_is_intro()?

Because if your getting started vignette is an article i.e. articles/pkg, this error happens too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
articles ✍️ bug an unexpected problem or unintended behavior
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants