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

Adding article with links to old website versions #2190

Merged
merged 7 commits into from
Oct 30, 2023

Conversation

ddsjoberg
Copy link
Collaborator

@ddsjoberg ddsjoberg commented Oct 25, 2023

@cicdguy this PR adds an article with links to older versions of the website
This is not ready for merging and is a Draft PR.

  • The "Version" dropdown menu needs to be updated with a link to this article's location. I think we discussed the dropdown including "Dev, Release, Prior Releases". I am not sure where this menu is being populated, but would probably be simplest to merely add it to the _pkgdown.yml ?
Screenshot 2023-10-25 at 10 10 49 AM

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the devel branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
  • Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Address any updates needed for vignettes and/or templates
  • Update NEWS.md under the header # admiral (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers)
  • Build admiral site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
  • Address or fix all lintr warnings and errors - lintr::lint_package()
  • Run R CMD check locally and address all errors and warnings - devtools::check()
  • Link the issue in the Development Section on the right hand side.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@cicdguy
Copy link
Collaborator

cicdguy commented Oct 25, 2023

Damn. This is so nice.
I think at some point we'll need it for other packages also.

Before we merge this in, we'll need to clean up the HTML pages a bit to remove the $Versions$ dropdown item from the navbar. I'll do that.

@github-actions
Copy link

github-actions bot commented Oct 25, 2023

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (4404 / 4473)

@ddsjoberg
Copy link
Collaborator Author

@cicdguy I used the base R pipe here which is available for R 4.1 and later. We don't ever run pkgdown workflow on older versions of R, right?

@cicdguy
Copy link
Collaborator

cicdguy commented Oct 25, 2023

Yes, we only run pkgdown for R 4.1+. Not for older versions.

@ddsjoberg ddsjoberg changed the title Adding vignette with links to old website versions Adding article with links to old website versions Oct 25, 2023
@ddsjoberg
Copy link
Collaborator Author

@cicdguy just to put this on your radar in case it's not already taken care of. When we use a package in a pkgdown article (not a vignette), we add the following to the DESCRIPTION file Config/Needs/website: gert. The vanilla pkgdown workflow from Posit will see this and install any of the packages listed here during the pkgdown build.

I am not sure if we are also performing this same check and installing these article dependencies into our images.

@cicdguy cicdguy marked this pull request as ready for review October 30, 2023 21:31
@cicdguy cicdguy merged commit 8e5ef2d into main Oct 30, 2023
19 of 21 checks passed
@cicdguy cicdguy deleted the pkgdown-version-article branch October 30, 2023 21:37
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