search

uclahs-cds / package-BoutrosLab-plotting-general

Functions to Create Publication-Quality Plots
https://uclahs-cds.github.io/package-BoutrosLab-plotting-general
12 stars 4 forks source link

Fix broken links at https://uclahs-cds.github.io/package-BoutrosLab-plotting-general/ #155

Open tyamaguchi-ucla opened 1 year ago

tyamaguchi-ucla commented 1 year ago 
          @dan-knight looks like we need to fix links here as well. https://uclahs-cds.github.io/package-BoutrosLab-plotting-general/

Originally posted by @tyamaguchi-ucla in https://github.com/uclahs-cds/package-BoutrosLab-plotting-general/issues/153#issuecomment-1722382673

dan-knight commented 1 year ago

Ah, looks like (for now) we need to manually rebuild and deploy the pkgdown site. We should look into automating this as well.

@jarbet Did you ever work on this with Stefan? Or are we starting from scratch?

jarbet commented 1 year ago

Ah, looks like (for now) we need to manually rebuild and deploy the pkgdown site. We should look into automating this as well.

@jarbet Did you ever work on this with Stefan? Or are we starting from scratch?

@dan-knight: I have not worked with pkgdown before

dan-knight commented 1 year ago

No worries. I'll look into doing it manually to get the hang of it, but it should be straightforward to automate with a GH action since it's running on GH Pages.

dan-knight commented 1 year ago

Update: Using this r-lib example action as a guide, I can build and deploy from an action. This now begs the question: Should the pkgdown docs website be synced to themain branch, or to the latest release? In other words, should this run on every push to main, or just on releases? (Our decision here will apply to all R packages, and could even be extended to other types of repo if a similar thing exists in other languages.)

lydiayliu commented 1 year ago

Sorry is there an update on this? The links to specific plot pages seem to still be broken: https://uclahs-cds.github.io/public-R-BoutrosLab-plotting-general/reference/create.boxplot.html

jarbet commented 1 year ago

https://uclahs-cds.github.io/public-R-BoutrosLab-plotting-general/reference/create.boxplot.html

@lydiayliu : I've been using this website instead, that @tyamaguchi-ucla sent me: https://github.com/uclahs-cds/package-BoutrosLab-plotting-general#function-reference

But I agree, it be good to fix the links in the github.io website version as well!

lydiayliu commented 1 year ago

thank you @jarbet, this is super helpful!!