search

ctsit / redcapcustodian

Simplified, automated data management on REDCap systems
Other
12 stars 6 forks source link

Add pkgdown site #102

Closed pbchase closed 1 year ago

pbchase commented 1 year ago

To review this PR, run pkgdown::build_site(). All the links should work except for those aimed at https://ctsit.github.io/redcapcustodian/ which cannot be built until this PR is merged and released. As far as I know, those links are required in the README. Perhaps that could be addressed by converting it to Rmd, but that is unclear and could be done as a future optimization.

All links aimed at non-package components cannot be satisfied within the vignettes/pkgdown system. They must be addressed via links to the source code in github. That's why we have those absolute URLs.

The pkgdown cannot present our NEWS.md as a ChangeLog because we used keepachangelog.com. This will be addresses in issue #103

pbchase commented 1 year ago

This is ready for review

pbchase commented 1 year ago

The warnings issued by pkgdown::build_site() will be addressed by issue #104

ChemiKyle commented 1 year ago

Assuming your warnings are the same as mine and merging.

Warning messages:
1: Failed to parse example for topic 'build_etl_job_log_df' 
2: call dbDisconnect() when finished working with a connection 
3: Failed to parse example for topic 'get_job_duration' 
4: Failed to parse example for topic 'write_error_log_entry' 
5: Failed to parse example for topic 'write_summary_metrics' 
6: Failed to parse example for topic 'write_to_sql_db'