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

Consider installation and badges for development version of site #1299

Closed
hadley opened this issue Apr 13, 2020 · 8 comments · Fixed by #1853
Closed

Consider installation and badges for development version of site #1299

hadley opened this issue Apr 13, 2020 · 8 comments · Fixed by #1853
Labels
deploy ✈️ feature a feature request or enhancement home 🏠

Comments

@hadley
Copy link
Member

hadley commented Apr 13, 2020

For popular tidyverse packages, displaying the GitHub installation instructions and the development badges causes more problems than it solves. Maybe we could display them only for the development version of the site when dev mode is set to auto?

(At the same time, it would be nice to have a separate sidebar entry that somehow captured best development practices like using unit tests, code coverage, CI, ...)

@jennybc
Copy link
Member

jennybc commented Apr 13, 2020

To expand on this a bit (it came from a slack convo), the main user-facing badge, if we have one on pkgdown landing page, should reflect the installation and usage experience that user is likely to have based on our testing. Having this badge reflect the worst result across the most recent run over a large build matrix seems too changeable / disconnected.

If there were more substantive differences like this, I think it might help maintainers decide whether to have a release vs. dev site and, if so, this provides motivation for it.

@hadley hadley added feature a feature request or enhancement home 🏠 labels May 12, 2020
@hadley

This comment has been minimized.

@hadley

This comment has been minimized.

@maelle

This comment has been minimized.

@hadley

This comment has been minimized.

@hadley
Copy link
Member Author

hadley commented Oct 22, 2021

I think there we probably want three categories of <div>:

  • don't show only on released site
  • don't show only on dev site
  • don't show at all

So maybe class='hide-dev', class='hide-release', class='hide-all' ?

Not sure whether we want "hide" or something else, since presumably we want to remove all together, not just hide with css display: none.

@hadley
Copy link
Member Author

hadley commented Oct 22, 2021

The sort of place where you'd see these class names are:

[![CRAN Status](https://www.r-pkg.org/badges/version/pkgdown)](https://cran.r-project.org/package=pkgdown){.hide-release}

This would primarily be accessible from .Rmd, not .Rd, since we don't have any good general ways of adding classes in .Rd.

@hadley
Copy link
Member Author

hadley commented Oct 25, 2021

Or maybe pkgdown-dev, pkgdown-release and pkgdown-hide?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy ✈️ feature a feature request or enhancement home 🏠
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants