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

On badges #95

Closed
maelle opened this issue Sep 20, 2022 · 4 comments · Fixed by #96
Closed

On badges #95

maelle opened this issue Sep 20, 2022 · 4 comments · Fixed by #96

Comments

@maelle
Copy link
Contributor

maelle commented Sep 20, 2022

@mpadge @jeroen

pkgdown now no longer includes badges in the sidebar for released website.

How to include software review badges?

  • one solution would be to list the software review issue number in the pkgdown config, and rotemplate would use that. It's one more thing to ask authors to do though, and I'd need to open many PRs for existing packages.
  • the build process could use the package registry to get that info, put it in the pkgdown config, and the rotemplate template would use that.

Visually, it could be a section like community but called "Software Review" with below the badges + a link to the issue not via the badge.

@maelle
Copy link
Contributor Author

maelle commented Sep 20, 2022

Example

issue_number <- 103
pkgdown::build_site(
  override = list(
    home = list(
      sidebar = list(
        structure = c("links", "license", "community", "citation", "authors", "softwarereview"),
        components = list(
          softwarereview = list(
            title = "Software Peer-Review",
            text = sprintf(
              "[![rOpenSci peer-review](https://badges.ropensci.org/%s_status.svg)](https://github.com/ropensci/software-review/issues/%s)",
              issue_number,
              issue_number
              )
          )
        )
      )
    )
  )
)

result

image

@jeroen
Copy link
Contributor

jeroen commented Sep 20, 2022

@maelle I like that! Can we easily add this to build_ropensci_docs() in this pkg?

@maelle
Copy link
Contributor Author

maelle commented Sep 20, 2022

yes I'll try that!

@mpadge
Copy link

mpadge commented Sep 20, 2022

I agree - that looks great !

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 a pull request may close this issue.

3 participants