Merge pull request #28 from jhudsl/repo-sync/AnVIL_Template/default

🔄 Synced file(s) with jhudsl/AnVIL_Template

Author: KatherineCox

.github/workflows/pull_request.yml

@@ -249,9 +249,8 @@ jobs:
       - name: Build components of the comment
         id: build-components
         run: |
-          course_name=$(head -n 1 student-guide/_bookdown.yml | cut -d'"' -f 2| tr " " "-")
           bookdown_link=$(echo "https://htmlpreview.github.io/?https://raw.githubusercontent.com/$GITHUB_REPOSITORY/preview-${{ github.event.pull_request.number }}/docs/index.html")
-          student_guide=$(echo "https://github.com/$GITHUB_REPOSITORY/raw/preview-${{ github.event.pull_request.number }}/student-guide/Student_Guide.docx")
+          student_guide=$(echo "https://github.com/$GITHUB_REPOSITORY/raw/preview-${{ github.event.pull_request.number }}/student-guide/docs/Student_Guide.docx")
           zip_link=$(echo "https://github.com/$GITHUB_REPOSITORY/raw/preview-${{ github.event.pull_request.number }}/website-preview.zip")
           echo "zip_link=$zip_link" >> $GITHUB_OUTPUT
           echo "bookdown_link=$bookdown_link" >> $GITHUB_OUTPUT

.github/workflows/render-all.yml

@@ -31,6 +31,7 @@ jobs:
       toggle_website: "${{ env.RENDER_WEBSITE }}"
       toggle_coursera: "${{ env.RENDER_COURSERA }}"
       toggle_leanpub: "${{ env.RENDER_LEANPUB }}"
+      make_book_txt: "${{ env.MAKE_BOOK_TXT }}"
       toggle_feedback_link: "${{ env.FEEDBACK_LINK }}"
       toggle_student_guide: "${{ env.RENDER_STUDENT_GUIDE }}"
       rendering_docker_image: "${{ env.RENDERING_DOCKER_IMAGE }}"

_output.yml

@@ -16,6 +16,6 @@ bookdown::gitbook:
        <p style="text-align:center;"> <a href="http://jhudatascience.org/"> The Johns Hopkins Data Science Lab </a></p>
        <a href="http://jhudatascience.org/"><img src="https://jhudatascience.org/images/dasl.png" style=" width: 80%; padding-left: 40px; padding-top: 8px; vertical-align: top "</a>
        <p style="text-align:center; font-size: 12px;"> <a href="https://github.com/rstudio4edu/rstudio4edu-book/"> Style adapted from: rstudio4edu-book </a> <a href ="https://creativecommons.org/licenses/by/2.0/"> (CC-BY 2.0) </a></p>
-       <p style="padding-left: 40px;"><div class="trapezoid" style = "padding-left: 40px;"><span><a href="https://docs.google.com/forms/d/e/1FAIpQLScrDVb_utm55pmb_SHx-RgELTEbCCWdLea0T3IzS0Oj00GE4w/viewform?usp=pp_url&entry.1565230805=AnVIL+CoFests!+2024"> Click here to provide feedback</a> <img src="assets/itcr_arrow.png" style=" width: 10%" ></span></div></p>
+       <p style="padding-left: 40px;"><div class="trapezoid" style = "padding-left: 40px;"><span><a href="https://docs.google.com/forms/d/e/1FAIpQLScrDVb_utm55pmb_SHx-RgELTEbCCWdLea0T3IzS0Oj00GE4w/viewform?usp=pp_url&entry.1565230805=your+course"> Click here to provide feedback</a> <img src="assets/itcr_arrow.png" style=" width: 10%" ></span></div></p>
        
-# Note: Do not edit the feedback link in this file. This is automatically edited through the render-preview and render-bookdown workflows.
+# Note: Do not edit the feedback link in this file. This is automatically edited through the render-preview and render-bookdown workflows.

config_automation.yml

@@ -25,8 +25,12 @@ render-website: rmd
 render-leanpub: no
 render-coursera: no
 
+## Automate the creation of Book.txt file? yes/no
+## This is only relevant if render-leanpub is yes, otherwise it will be ignored
+make-book-txt: yes
+
 ##### Rendering of student guide (if applicable)
-render-student-guide: no
+render-student-guide: yes
 
 ##### Auto-generate a feedback link for the AnVIL Feedback Form: https://docs.google.com/forms/d/e/1FAIpQLScrDVb_utm55pmb_SHx-RgELTEbCCWdLea0T3IzS0Oj00GE4w/viewform
 feedback-link: yes

student-guide.Rmd

@@ -0,0 +1,20 @@
+
+# Student Guide
+
+## Activity One
+
+Many of the AnVIL books that are designed for teaching a class or workshop contain information aimed at the instructor.
+
+You might want to create a "student guide" that contains a different subset of Rmd files from your book, or renders to a different output format (e.g. word document). You can specify the output and Rmd files that will be used for the student guide using the `_output.yml` and `_bookdown.yml` files in the `student-guide` directory.
+
+By default, repositories based on `AnVIL_Template` create a docx file containing this chapter as an example. Once you have adjusted `student-guide/bookdown.yml` to include the chapters you want in your student guide, you can link to it by replacing `{repo-name}` in the following URL:
+
+`https://github.com/jhudsl/{repo-name}/raw/main/student-guide/docs/Student_Guide.docx`
+
+When someone clicks this link, they will download the docx file. For example, here is the link for the student guide from `AnVIL_Template`:
+
+https://github.com/jhudsl/AnVIL_Template/raw/main/student-guide/docs/Student_Guide.docx
+
+## Activity Two
+
+Steps of the guide could go here.

student-guide/_bookdown.yml

@@ -1,13 +1,14 @@
-book_filename: "Student_Guide"
 chapter_name: "Chapter "
-repo: https://github.com/jhudsl/AnVIL_Template/
+repo: https://github.com/jhudsl/AnVIL_CoFests_2024/
 rmd_files: ["index.Rmd",
-            "09-student_guide.Rmd",
+            "student-guide.Rmd",
+            "About.Rmd",
             "References.Rmd"]
 new_session: yes
 bibliography: [book.bib]
 delete_merged_file: true
 language:
   ui:
     chapter_name: "Chapter"
-output_dir: "student-guide"
+book_filename: "Student_Guide" # Do not change
+output_dir: "student-guide/docs" # Do not change

style-sets/AnVIL_FH/_output.yml

@@ -2,6 +2,7 @@ bookdown::gitbook:
   # When using multiple css files, the default file path will be the first one #
   css: [assets/style.css, assets/AnVIL_style/anvil.css]
   includes:
+    in_header: GA_Script.html
     before_body: assets/AnVIL_style/big-image_anvil.html
     after_body: assets/AnVIL_style/footer.html
   highlight: tango

style-sets/AnVIL_JHU/_output.yml

@@ -2,6 +2,7 @@ bookdown::gitbook:
   # When using multiple css files, the default file path will be the first one #
   css: [assets/style.css, assets/AnVIL_style/anvil.css]
   includes:
+    in_header: GA_Script.html
     before_body: assets/AnVIL_style/big-image_anvil.html
     after_body: assets/AnVIL_style/footer.html
   highlight: tango

style-sets/GDSCN/_output.yml

@@ -2,6 +2,7 @@ bookdown::gitbook:
   # When using multiple css files, the default file path will be the first one #
   css: [assets/style.css, assets/GDSCN_style/gdscn.css]
   includes:
+    in_header: GA_Script.html
     before_body: assets/GDSCN_style/big-image_gdscn.html
     after_body: assets/GDSCN_style/footer.html
   highlight: tango

style-sets/GDSCN_JHU/_output.yml

@@ -2,6 +2,7 @@ bookdown::gitbook:
   # When using multiple css files, the default file path will be the first one #
   css: [assets/style.css, assets/GDSCN_style/gdscn.css]
   includes:
+    in_header: GA_Script.html
     before_body: assets/GDSCN_style/big-image_gdscn.html
     after_body: assets/GDSCN_style/footer.html
   highlight: tango