Closed Bai-Li-NOAA closed 3 months ago
@Schiano-NOAA, I have created a feature branch to add a pkgdown site for exploration as we discussed. Since you can only create one website for this repo, we have two options:
Keep the current bookdown website as the main site:
Use the pkgdown website as the main site (See FIMS example here):
Let me know your preference, and I can help with the remaining tasks.
@Bai-Li-NOAA I am comfortable with either option. I think as long as we keep the content as intended the same then that's fine. We can switch to using the pkgdown site for simplicity. Should I remove the content from the old site before merging?
@Schiano-NOAA, Let's migrate the bookdown content to the pkgdown vignettes before removing it. I can do it within the current pull request and and notify you for review once it's ready.
@Bai-Li-NOAA Sounds great. Thanks for getting on this
@Bai-Li-NOAA I was removing some of the old content and forgot about this thread. I restored some of the material in a branch website_materials, but some of the information was in a separate branch I already removed. I saved it locally and will just add it to the pkgdown site once that is uploaded and running.
@Schiano-NOAA, thanks for the update. I have added the workflows to render the pkgdown site to the PR. I wasn't able to find the branch website_materials, but I'll leave it to you to decide which materials to include in the pkgdown vignettes. I still think you can have both websites: a pkgdown website for references manuals and a bookdown website for user guide, if you prefer the bookdown format. See the flextable examples here and here.
@Bai-Li-NOAA Sorry Bai! I am now realizing I did not push the branch this morning. Either way I will merge this branch to the main and make adjustments from there.
This PR contributes the development of the pkgdown site for the R package by
.Rbuildignore
and.gitignore
firesTo render the website locally, go to the
add-pkgdown-site
branch and runpkgdown::build_site()