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

Closes #2205 add previous website links #2207

Merged
merged 7 commits into from
Nov 1, 2023
Merged

Closes #2205 add previous website links #2207

merged 7 commits into from
Nov 1, 2023

Conversation

ddsjoberg
Copy link
Collaborator

@ddsjoberg ddsjoberg commented Oct 30, 2023

@cicdguy and I have been working on the pkgdown site updates. I am now adding back a link to the previous versions of the website. We could keep the menu to what it looked like before, or (and my preference) is to add a small history button on the RHS of the nav bar that links to the historic versions of the website. Thoughts?

image

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 DESCRIPTION file has incorrect version #2204, Closes Add Versions menu to the pkgdown site #2205 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!

@github-actions
Copy link

github-actions bot commented Oct 30, 2023

Code Coverage

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

@jeffreyad
Copy link
Collaborator

Would it be possible to add a link to the dev version of the website?

@ddsjoberg
Copy link
Collaborator Author

Would it be possible to add a link to the dev version of the website?

Yes, we could add it the versions article very easily

@ddsjoberg
Copy link
Collaborator Author

@jeffreyad added dev version link to the versions article
image

@jeffreyad
Copy link
Collaborator

@jeffreyad added dev version link to the versions article image

Thanks @ddsjoberg that looks great!

@ddsjoberg ddsjoberg requested a review from jeffreyad November 1, 2023 19:03
Copy link
Collaborator

@zdz2101 zdz2101 left a comment

Choose a reason for hiding this comment

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

Fire away! Won't know how it looks until a full go right?

@ddsjoberg ddsjoberg changed the title website links Closes #2205 add previous website links Nov 1, 2023
@ddsjoberg ddsjoberg merged commit 88628fc into main Nov 1, 2023
21 checks passed
@ddsjoberg ddsjoberg deleted the version-menu branch November 1, 2023 20:15
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.

Add Versions menu to the pkgdown site DESCRIPTION file has incorrect version
3 participants