From 8a93716bd70f14218b22c5922d09fd61a6c3dbf6 Mon Sep 17 00:00:00 2001 From: Quarto GHA Workflow Runner Date: Thu, 7 Dec 2023 18:46:54 +0000 Subject: [PATCH] Built site for gh-pages --- .nojekyll | 2 +- content/NEFSC-YT-case-study.html | 120 ++++++------- .../{customizing.html => SWFSC-sardine.html} | 87 ++++++---- content/acknowledgements.html | 2 +- content/case-study-template.html | 6 +- content/publishing.html | 2 +- content/rendering.html | 6 +- content/rmarkdown.html | 2 +- index.html | 2 +- search.json | 162 +++++++++++++++--- sitemap.xml | 18 +- 11 files changed, 269 insertions(+), 140 deletions(-) rename content/{customizing.html => SWFSC-sardine.html} (76%) diff --git a/.nojekyll b/.nojekyll index 832c3a0..4fce8fe 100644 --- a/.nojekyll +++ b/.nojekyll @@ -1 +1 @@ -27faa856 \ No newline at end of file +58102ae9 \ No newline at end of file diff --git a/content/NEFSC-YT-case-study.html b/content/NEFSC-YT-case-study.html index 667be1a..da6d015 100644 --- a/content/NEFSC-YT-case-study.html +++ b/content/NEFSC-YT-case-study.html @@ -7,7 +7,7 @@ -NOAA FIMS case studies - Rendering with Code +NOAA FIMS case studies - Customize @@ -154,7 +120,7 @@
  • - + Customizing
    • @@ -192,8 +158,16 @@

    On this page

    Edit this page

    View source

    Report an issue

    @@ -202,7 +176,7 @@

    On this page

    -

    Rendering with Code

    +

    Customize

    @@ -217,32 +191,50 @@

    Rendering with Code

    -

    You can have code (R, Python or Julia) in your qmd file. You will need to have these installed on your local computer, but presumably you do already if you are adding code to your qmd files.

    -
    -
    x <- c(5, 15, 25, 35, 45, 55)
-y <- c(5, 20, 14, 32, 22, 38)
-lm(x ~ y)
    -
    -
    
-Call:
-lm(formula = x ~ y)
-
-Coefficients:
-(Intercept)            y  
-      1.056        1.326
    -
    -
    -
    -

    Modify the GitHub Action

    -

    You will need to change the GitHub Action in .github/workflows to install these and any needed packages in order for GitHub to be able to render your webpage. The GitHub Action install R since I used that in code.qmd. If you use Python or Julia instead, then you will need to update the GitHub Action to install those.

    -

    If getting the GitHub Action to work is too much hassle (and that definitely happens), you can alway render locally and publish to the gh-pages branch. If you do this, make sure to delete or rename the GitHub Action to something like

    -
    render-and-publish.old_yml
    -

    so GitHub does not keep trying to run it. Nothing bad will happen if you don’t do this, but if you are not using the action (because it keeps failing), then you don’t need GitHub to run it.

    +
    +

    Edit and add your pages

    +

    Each page should start with

    +
    ---
+title: your title
+---
    +

    and the first header will be the 2nd level, so ##. Note, there are situations where you leave off

    +
    ---
+title: your title
+---
    +

    and start the qmd file with a level header #, but if using the default title yaml (in the --- fence) is a good habit since it makes it easy for Quarto convert your qmd file to other formats (like into a presentation).

    +
    +
    +

    Add a chunk of code describing your setup

    +

    Case study files should include: * R version * TMB version * FIMS commit * Name of your stock * Name of your region * Name of the analyst

    +
    +
    +

    Add a bulleted list and script describing simplifications you had to make

    +

    How I simplified my assessment * Remove seasonality * etc.

    +
    +
    +

    Add your script that sets up and runs the model

    +
    +
    +

    Add your comparison figures

    +
    +
    +

    Add comparison tables

    +
    +
    +

    What was your experience using FIMS? What could we do to improve usability?

    +
    +
    +

    List any issues that you ran into or found

    +

    Please open an issue if you found something new.

    +
    +
    +

    What features are most important to add based on this case study?

    -
    -

    Render locally and publish to gh-pages branch

    -

    To render locally and push up to the gh-pages branch, open a terminal window and then cd to the directory with the Quarto project. Type this in the terminal:

    -
    quarto render gh-pages
    +
    +

    Add your pages to the project

    +
      +
    • Add the files to _quarto.yml
      • +
    diff --git a/content/customizing.html b/content/SWFSC-sardine.html similarity index 76% rename from content/customizing.html rename to content/SWFSC-sardine.html index 8f81a76..f7b3c3c 100644 --- a/content/customizing.html +++ b/content/SWFSC-sardine.html @@ -7,7 +7,7 @@ -NOAA FIMS case studies - Customization +NOAA FIMS case studies - Customize