Merge pull request #567 from cmu-delphi/delphidocs-dev

delphidocs on dev

Author: brookslogan

.github/workflows/pkgdown.yaml

@@ -28,7 +28,7 @@ jobs:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       DELPHI_EPIDATA_KEY: ${{ secrets.SECRET_EPIPROCESS_GHACTIONS_DELPHI_EPIDATA_KEY }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -42,19 +42,14 @@ jobs:
           needs: website
 
       - name: Build site
-        # - target_ref gets the ref from a different variable, depending on the event
-        # - override allows us to set the pkgdown mode and version_label
-        #   - mode: release is the standard build mode, devel places the site in /dev
-        #   - version_label: 'light' and 'success' are CSS labels for Bootswatch: Cosmo
-        #                    https://bootswatch.com/cosmo/
-        # - we use pkgdown:::build_github_pages to build the site because of an issue in pkgdown
-        #   https://github.com/r-lib/pkgdown/issues/2257
+        # our versioning system+dev branch doesn't match the requirements for
+        # develop mode = auto
         run: |
           target_ref <- "${{ github.event_name == 'pull_request' && github.base_ref || github.ref }}"
           override <- if (target_ref == "main" || target_ref == "refs/heads/main") {
-            list(development = list(mode = "release", version_label = "light"))
+            list(development = list(mode = "release"))
           } else if (target_ref == "dev" || target_ref == "refs/heads/dev") {
-            list(development = list(mode = "devel", version_label = "success"))
+            list(development = list(mode = "devel"))
           } else {
             stop("Unexpected target_ref: ", target_ref)
           }
@@ -67,7 +62,7 @@ jobs:
 
       - name: Deploy to GitHub pages 🚀
         if: github.event_name != 'pull_request'
-        uses: JamesIves/github-pages-deploy-action@v4.4.1
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
         with:
           clean: false
           branch: gh-pages

DESCRIPTION

@@ -72,10 +72,12 @@ Suggests:
 VignetteBuilder:
     knitr
 Remotes:
+    cmu-delphi/delphidocs,
     cmu-delphi/epidatasets,
     cmu-delphi/epidatr,
     glmgen/genlasso,
     reconverse/outbreaks
+Config/Needs/website: cmu-delphi/delphidocs
 Config/testthat/edition: 3
 Config/testthat/parallel: true
 Copyright: file inst/COPYRIGHTS

_pkgdown.yml

@@ -1,40 +1,25 @@
-# Colors should stay consistent across epipredict, epiprocess, and epidatr,
-# using Carnegie Red
-# https://www.cmu.edu/brand/brand-guidelines/visual-identity/colors.html
-
-# This is to give a default value to the `mode` parameter in the
-# `pkgdown::build_site` function. This is useful when building the site locally,
-# as it will default to `devel` mode. In practice, this should all be handled
-# dynamically by the CI/CD pipeline.
 development:
   mode: devel
-  version_label: success
 
 template:
-  bootstrap: 5
-  bootswatch: cosmo
-  bslib:
-    font_scale: 1.0
-    primary: "#C41230"
-    success: "#B4D43C"
-    link-color: "#C41230"
-
-navbar:
-  bg: primary
-  type: light
+  package: delphidocs
 
 url: https://cmu-delphi.github.io/epiprocess/
 
 home:
   links:
-    - text: Introduction to Delphi's Tooling Work
-      href: https://cmu-delphi.github.io/delphi-tooling-book/
-    - text: Get the epipredict R package
+    - text: The epipredict package
       href: https://cmu-delphi.github.io/epipredict/
-    - text: Get the epidatr R package
-      href: https://github.com/cmu-delphi/epidatr
-    - text: Get the epidatasets R package
-      href: https://cmu-delphi.github.io/epidatasets/
+  sidebar:
+    structure: [links, license, community, citation, authors, dev, related]
+    components:
+      related:
+        title: Delphi packages and resources
+        text: |
+          * [The epidatr package](https://github.com/cmu-delphi/epidatr/)
+          * [The epipredict package](https://cmu-delphi.github.io/epipredict/)
+          * [The epidatasets package](https://cmu-delphi.github.io/epidatasets/)
+          * [Introduction to Delphi's Tooling Work](https://cmu-delphi.github.io/delphi-tooling-book/)
 
 articles:
   - title: Using the package
@@ -54,10 +39,9 @@ articles:
 
 repo:
   url:
-    home: https://github.com/cmu-delphi/epiprocess/tree/main/
-    source: https://github.com/cmu-delphi/epiprocess/blob/main/
+    home: https://github.com/cmu-delphi/epiprocess/
+    source: https://github.com/cmu-delphi/epiprocess/
     issue: https://github.com/cmu-delphi/epiprocess/issues
-    user: https://github.com/
 
 reference:
   - title: "`epi_df` basics"