Fix broken documentation links (#3710)#3933
Fix broken documentation links (#3710)#3933clarissecheung wants to merge 13 commits intoPecanProject:developfrom
Conversation
… links Replace outdated URLs for pkgdown package docs, gitbooks, coding style, SIPNET install guide, and other moved documentation pages with their current equivalents. Closes PecanProject#3710 (partial)
…3710) The old http://opensource.ncsa.illinois.edu/license.html returns 404. Replace with https://opensource.org/licenses/NCSA across 20 model files.
….ch, safaribooksonline.com (PecanProject#3710) - cfconventions.org (NXDOMAIN) → cf-convention.github.io (GitHub Pages) - nacp.ornl.gov → nacp-prod.ornl.gov (new ORNL host) - php-osx.liip.ch (dead) → formulae.brew.sh/formula/php (Homebrew) - proquestcombo.safaribooksonline.com (dead) → GitHub-hosted PDF
… NLCD, JULES, GitHub internal paths (PecanProject#3710)
Convert placeholder URLs from hyperlinks to backtick-formatted code so link checkers skip them and readers understand they are templates: - http://server/bety/ in 07_migrate.Rmd - https://your.server.edu/shiny/your-location in shiny.Rmd - http://server/rstudio in DEV-INTRO.md
|
hey @clarissecheung verified a few replacement URLs = nacp-prod.ornl.gov, cf-convention.github.io and the pecanproject.github.io/package-documentation links all look good 👍 |
infotroph
left a comment
infotroph
left a comment
There was a problem hiding this comment.
Thanks! This is a nice contribution. See inline for a couple nitpicks on some of the older links.
…s/02_git/01_using-git.Rmd Co-authored-by: Chris Black <chris@ckblack.org>
…Installing-PEcAn-OSX.Rmd Co-authored-by: Chris Black <chris@ckblack.org>
Thank you for the feedback! I've gone ahead and committed your suggestions! |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
hi @omkarrr2533! Thank you for catching that! I've run devtools::document() and have made changes the the necessary files. |
|
@clarissecheung Your roxygen update looks like it touched one package out of the 7 (if I counted right) that this PR modifies. You could run devtools::document() on each of them one at a time if you want, but instead I recommend running |
Got it! I just ran make document and pushed the updated files. Let me know if I can do anything else. Thank you so much for your help! |
|
@clarissecheung The CI failure is reminding us I missed there's one more task to do: Edit line 4 of Thanks for taking on the task and sticking with it! The hazard of PRs that touch a lot of packages is that they wind up hitting lots of little maintenance tasks like these... |
…ct#3710) Bumps models/cable to 1.7.5.9000 and adds Version: 0.1.0.9000 to shiny/workflowPlot to satisfy the check_versionbump CI step.
@infotroph Just pushed! Thank you again for your guidance with this! |
4 participants
Fixes ~100 broken links across 67 files, identified by a link checker report.
Changes by commit:
pecanproject.github.ioandpecan.gitbooks.iolinks — mapped to current doc site URLs or GitHub source filesopensource.ncsa.illinois.edu/license.html) with canonical OSI link (opensource.org/license/NCSA)cfconventions.org,nacp.ornl.gov,php-osx.liip.ch,safaribooksonline.com) using Wayback Machine archiveshttp://server/bety/) as inline code so they aren't treated as broken linksOnly URLs were modified — no content changes. Links that couldn't be resolved (403s from DOI/publisher sites, timeouts) were left in place to avoid information loss.
Closes #3710