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

DESCRIPTION: add pkgdown site to URL field #67

Merged
merged 1 commit into from
Jul 12, 2024
Merged

Conversation

kyleam
Copy link
Collaborator

@kyleam kyleam commented Jul 10, 2024

As of pkgdown 2.1.0, check_pkgdown() fails with

Error in `pkgdown::check_pkgdown()`:
! In DESCRIPTION, URL is missing package url
(https://metrumresearchgroup.github.io/mpn.scorecard).
ℹ See details in `vignette(pkgdown::metadata)`.

The main advantage of listing the pkgdown site in the DESCRIPTION's URL field is that it enables pkgdown to auto-link to mpn.scorecard pages when building another package's site.

https://pkgdown.r-lib.org/articles/linking.html#across-packages

As of pkgdown 2.1.0, check_pkgdown() fails with

    Error in `pkgdown::check_pkgdown()`:
    ! In DESCRIPTION, URL is missing package url
    (https://metrumresearchgroup.github.io/mpn.scorecard).
    ℹ See details in `vignette(pkgdown::metadata)`.

The main advantage of listing the pkgdown site in the DESCRIPTION's
URL field is that it enables pkgdown to auto-link to mpn.scorecard
pages when building another package's site.

https://pkgdown.r-lib.org/articles/linking.html#across-packages
@kyleam kyleam requested a review from barrettk July 10, 2024 16:28
Copy link
Collaborator

@barrettk barrettk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@kyleam kyleam merged commit dcc2462 into main Jul 12, 2024
4 checks passed
@kyleam kyleam deleted the desc-pkgdown-url branch July 12, 2024 14:56
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