docs.ropensci.org guidance #162
Conversation
Co-Authored-By: Hugo Gruson <[email protected]>
|
Thanks, this sounds great. I'm not sure if we should recommend to setup pkgdown via tic/travis while they are in the onboarding process. Doing so will advertise the package website on a custom url, and once they the onboarding has completed, hey have to remove their integration again and then update the website url everywhere they have advertised it. Other than that I really like it, thanks! |
|
Thank you!
Good point, I'll think about it. We do want them to have an "easy" way to have an up-to-date pkgdown website during development/review because reviewers will read it (a pkgdown website could be a good point of entry for a review), but I see the problem. Maybe I'll write a helper function to update links. 🤔 |
|
👋 @ropensci/editors any feedback on this PR, and any opinion on @jeroen's remark above? Thanks in advance! 😸 |
* update dev (#157) * draft book release guidance (#152) * include the book release guidance in the book * update news * clarify release guidance * Remove "click here" link (#166) * Update all links to HTTPS (#167) * URLs should be enclosed in angle brackets, e.g. <https://www.r-project.org> (#169) --https://cran.r-project.org/doc/manuals/r-release/R-exts.html * Expand on what 'more discoverable' means (#172) * fix @melvidoni's affiliation in dev too * new dev guide URL * add mention of usethis functions for adding testing or vignette infrastructure in the part about dependencies in the package building guide thx @cboettig fix #112 * remove recommendation about `roxygen2` dev version since the latest stable version has what is needed. fix #165 thanks @Bisaloo * add more details about gitflow * more direct link to Amanda's write-up * update ref to R pkg book * fix #163 now that the book is less new * Update pkg_building.Rmd (#178) * Update pkg_building.Rmd See #151 * Update appendix.Rmd As requested. * Update index.Rmd As requested. * Rodev mentions (#176) Fix #48 * CRAN checks explanations (#177) * Explain CRAN checks * add that rOpenSci maintains API Fix #175 * docs.ropensci.org guidance (#162) fix #164 and cf #155 * fix #155 by improving pkgdown guidance * suggest R Markdown hunks approach for README and vignette (#161) * fix #179 by fixing formatting of Appendices B-D in the pdf version of the book * make NEWs template look ok again cf #179 * fix ref to R packages book * add link to rOpenSci community call "Security for R" to security chapter cf #154 * Add note about pkgreviewr Rstudio dependency. Resolves #183 * Break up reproducibility category into component parts (#184) - Also increase clarity that software wrappers are for non-R programs - Re-arrange thematically - Add appropriate examples Closes ropensci/software-review-meta#81 * fix #192 update instructions in readme for rendering book locally, _book instead of _output and updated NEWS * fix spelling and missing "an" in Code Style subsection within Packaging Guide section (#182) * fix #193 change slack channel name to software-review from onboarding in editor checklist add entry to news * #128 taking over maint. chapter work, moved to new branch * move taking over to chapter 10 * spelling changs in taking over chapter * add news item for the taking over chapter #128 * Update JOSS instrucctions * Explicitly use RO repo url in JOSS submittal. * fix #180 add note for handling editors to nominate blog posts of interest * fix some links in the changelog * Fix #181 typo * fix #191 add to approval template mention of including docs.ropensci.org link in DESCRIPTION file * fix section link to docsropensci in pkg building chapter, was missing pound sign * fix some broken urls in pkg_building * fix spelling problems after using spelling
I'll add other pkgdown guidance but for now I want to make sure I'm writing correct stuff about the central builds.
@jeroen can you have a first look before I ask editors?