removed code style guide from resources; added links to quarto docume…

…ntation and github docs to resources menu
UCSB-MEDS · Aug 22, 2024 · 79e23b8 · 79e23b8
1 parent 059d6f4
commit 79e23b8
Show file tree

Hide file tree

Showing 12 changed files with 83 additions and 39 deletions.
diff --git a/_quarto.yml b/_quarto.yml
@@ -33,10 +33,15 @@ website:
             href: course-materials/week6-misc-github.qmd
       - text: resources
         menu: 
-          - text: guide for writing clean code
-            href: clean-code-guide.qmd
           - text: MEDS installation guide
             href: https://ucsb-meds.github.io/MEDS-installation-guide/
+            target: _blank
+          - text: Quarto documentation
+            href: https://quarto.org/
+            target: _blank
+          - text: GitHub documentation
+            href: https://docs.github.com/en
+            target: _blank
       - icon: github
         menu:
           - text: Source Code

diff --git a/course-materials/week5-github-portfolios.qmd b/course-materials/week5-github-portfolios.qmd
@@ -71,6 +71,8 @@ We'll discuss and practice writing effective GitHub READMEs together today, but
 
 :::
 
+TODO: include this somewhere, [5 tips for making your GitHub profile page accessible](https://github.blog/developer-skills/github/5-tips-for-making-your-github-profile-page-accessible/)
+
 ## {{< fa plus title="plus" >}} What should I continue working on? {#continue-working}
 
 *Coming soon*
diff --git a/docs/about.html b/docs/about.html
@@ -171,12 +171,16 @@
     </a>
     <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="nav-menu-resources">    
         <li>
-    <a class="dropdown-item" href="./clean-code-guide.html">
- <span class="dropdown-text">guide for writing clean code</span></a>
+    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/" target="_blank">
+ <span class="dropdown-text">MEDS installation guide</span></a>
   </li>  
         <li>
-    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/">
- <span class="dropdown-text">MEDS installation guide</span></a>
+    <a class="dropdown-item" href="https://quarto.org/" target="_blank">
+ <span class="dropdown-text">Quarto documentation</span></a>
+  </li>  
+        <li>
+    <a class="dropdown-item" href="https://docs.github.com/en" target="_blank">
+ <span class="dropdown-text">GitHub documentation</span></a>
   </li>  
     </ul>
   </li>

diff --git a/docs/clean-code-guide.html b/docs/clean-code-guide.html
@@ -171,12 +171,16 @@
     </a>
     <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="nav-menu-resources">    
         <li>
-    <a class="dropdown-item" href="./clean-code-guide.html">
- <span class="dropdown-text">guide for writing clean code</span></a>
+    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/" target="_blank">
+ <span class="dropdown-text">MEDS installation guide</span></a>
   </li>  
         <li>
-    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/">
- <span class="dropdown-text">MEDS installation guide</span></a>
+    <a class="dropdown-item" href="https://quarto.org/" target="_blank">
+ <span class="dropdown-text">Quarto documentation</span></a>
+  </li>  
+        <li>
+    <a class="dropdown-item" href="https://docs.github.com/en" target="_blank">
+ <span class="dropdown-text">GitHub documentation</span></a>
   </li>  
     </ul>
   </li>

diff --git a/docs/course-materials/week0-build-websites.html b/docs/course-materials/week0-build-websites.html
@@ -138,12 +138,16 @@
     </a>
     <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="nav-menu-resources">    
         <li>
-    <a class="dropdown-item" href="../clean-code-guide.html">
- <span class="dropdown-text">guide for writing clean code</span></a>
+    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/" target="_blank">
+ <span class="dropdown-text">MEDS installation guide</span></a>
   </li>  
         <li>
-    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/">
- <span class="dropdown-text">MEDS installation guide</span></a>
+    <a class="dropdown-item" href="https://quarto.org/" target="_blank">
+ <span class="dropdown-text">Quarto documentation</span></a>
+  </li>  
+        <li>
+    <a class="dropdown-item" href="https://docs.github.com/en" target="_blank">
+ <span class="dropdown-text">GitHub documentation</span></a>
   </li>  
     </ul>
   </li>

diff --git a/docs/course-materials/week2-customizing-websites.html b/docs/course-materials/week2-customizing-websites.html
@@ -172,12 +172,16 @@
     </a>
     <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="nav-menu-resources">    
         <li>
-    <a class="dropdown-item" href="../clean-code-guide.html">
- <span class="dropdown-text">guide for writing clean code</span></a>
+    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/" target="_blank">
+ <span class="dropdown-text">MEDS installation guide</span></a>
   </li>  
         <li>
-    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/">
- <span class="dropdown-text">MEDS installation guide</span></a>
+    <a class="dropdown-item" href="https://quarto.org/" target="_blank">
+ <span class="dropdown-text">Quarto documentation</span></a>
+  </li>  
+        <li>
+    <a class="dropdown-item" href="https://docs.github.com/en" target="_blank">
+ <span class="dropdown-text">GitHub documentation</span></a>
   </li>  
     </ul>
   </li>

diff --git a/docs/course-materials/week3-creating-blogs.html b/docs/course-materials/week3-creating-blogs.html
@@ -138,12 +138,16 @@
     </a>
     <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="nav-menu-resources">    
         <li>
-    <a class="dropdown-item" href="../clean-code-guide.html">
- <span class="dropdown-text">guide for writing clean code</span></a>
+    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/" target="_blank">
+ <span class="dropdown-text">MEDS installation guide</span></a>
   </li>  
         <li>
-    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/">
- <span class="dropdown-text">MEDS installation guide</span></a>
+    <a class="dropdown-item" href="https://quarto.org/" target="_blank">
+ <span class="dropdown-text">Quarto documentation</span></a>
+  </li>  
+        <li>
+    <a class="dropdown-item" href="https://docs.github.com/en" target="_blank">
+ <span class="dropdown-text">GitHub documentation</span></a>
   </li>  
     </ul>
   </li>

diff --git a/docs/course-materials/week4-writing-blogs.html b/docs/course-materials/week4-writing-blogs.html
@@ -138,12 +138,16 @@
     </a>
     <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="nav-menu-resources">    
         <li>
-    <a class="dropdown-item" href="../clean-code-guide.html">
- <span class="dropdown-text">guide for writing clean code</span></a>
+    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/" target="_blank">
+ <span class="dropdown-text">MEDS installation guide</span></a>
   </li>  
         <li>
-    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/">
- <span class="dropdown-text">MEDS installation guide</span></a>
+    <a class="dropdown-item" href="https://quarto.org/" target="_blank">
+ <span class="dropdown-text">Quarto documentation</span></a>
+  </li>  
+        <li>
+    <a class="dropdown-item" href="https://docs.github.com/en" target="_blank">
+ <span class="dropdown-text">GitHub documentation</span></a>
   </li>  
     </ul>
   </li>

diff --git a/docs/course-materials/week5-github-portfolios.html b/docs/course-materials/week5-github-portfolios.html
@@ -138,12 +138,16 @@
     </a>
     <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="nav-menu-resources">    
         <li>
-    <a class="dropdown-item" href="../clean-code-guide.html">
- <span class="dropdown-text">guide for writing clean code</span></a>
+    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/" target="_blank">
+ <span class="dropdown-text">MEDS installation guide</span></a>
   </li>  
         <li>
-    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/">
- <span class="dropdown-text">MEDS installation guide</span></a>
+    <a class="dropdown-item" href="https://quarto.org/" target="_blank">
+ <span class="dropdown-text">Quarto documentation</span></a>
+  </li>  
+        <li>
+    <a class="dropdown-item" href="https://docs.github.com/en" target="_blank">
+ <span class="dropdown-text">GitHub documentation</span></a>
   </li>  
     </ul>
   </li>
@@ -295,6 +299,7 @@ <h2 class="anchored" data-anchor-id="lecture-materials"><i class="fa-solid fa-pe
 </div>
 </div>
 </div>
+<p>TODO: include this somewhere, <a href="https://github.blog/developer-skills/github/5-tips-for-making-your-github-profile-page-accessible/">5 tips for making your GitHub profile page accessible</a></p>
 </section>
 <section id="continue-working" class="level2">
 <h2 class="anchored" data-anchor-id="continue-working"><i class="fa-solid fa-plus" title="plus" aria-label="plus"></i> What should I continue working on?</h2>

diff --git a/docs/course-materials/week6-misc-github.html b/docs/course-materials/week6-misc-github.html
@@ -138,12 +138,16 @@
     </a>
     <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="nav-menu-resources">    
         <li>
-    <a class="dropdown-item" href="../clean-code-guide.html">
- <span class="dropdown-text">guide for writing clean code</span></a>
+    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/" target="_blank">
+ <span class="dropdown-text">MEDS installation guide</span></a>
   </li>  
         <li>
-    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/">
- <span class="dropdown-text">MEDS installation guide</span></a>
+    <a class="dropdown-item" href="https://quarto.org/" target="_blank">
+ <span class="dropdown-text">Quarto documentation</span></a>
+  </li>  
+        <li>
+    <a class="dropdown-item" href="https://docs.github.com/en" target="_blank">
+ <span class="dropdown-text">GitHub documentation</span></a>
   </li>  
     </ul>
   </li>

diff --git a/docs/index.html b/docs/index.html
@@ -138,12 +138,16 @@
     </a>
     <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="nav-menu-resources">    
         <li>
-    <a class="dropdown-item" href="./clean-code-guide.html">
- <span class="dropdown-text">guide for writing clean code</span></a>
+    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/" target="_blank">
+ <span class="dropdown-text">MEDS installation guide</span></a>
   </li>  
         <li>
-    <a class="dropdown-item" href="https://ucsb-meds.github.io/MEDS-installation-guide/">
- <span class="dropdown-text">MEDS installation guide</span></a>
+    <a class="dropdown-item" href="https://quarto.org/" target="_blank">
+ <span class="dropdown-text">Quarto documentation</span></a>
+  </li>  
+        <li>
+    <a class="dropdown-item" href="https://docs.github.com/en" target="_blank">
+ <span class="dropdown-text">GitHub documentation</span></a>
   </li>  
     </ul>
   </li>

diff --git a/docs/search.json b/docs/search.json
@@ -53,7 +53,7 @@
     "href": "course-materials/week5-github-portfolios.html#lecture-materials",
     "title": "GitHub as a professional portfolio",
     "section": " Lecture Materials",
-    "text": "Lecture Materials\nWe’ll discuss and practice writing effective GitHub READMEs together today, but you’ll also be asked to refer back to these materials throughout your time in MEDS. Find README guidelines, as well as instructions for adding a GitHub profile README and creating a GitHub organization, below:\n\n\n\n README Guidelines\n\n\n\n\n Add a profile README\n\n\n\n\n Create a GitHub Organization"
+    "text": "Lecture Materials\nWe’ll discuss and practice writing effective GitHub READMEs together today, but you’ll also be asked to refer back to these materials throughout your time in MEDS. Find README guidelines, as well as instructions for adding a GitHub profile README and creating a GitHub organization, below:\n\n\n\n README Guidelines\n\n\n\n\n Add a profile README\n\n\n\n\n Create a GitHub Organization\n\n\n\nTODO: include this somewhere, 5 tips for making your GitHub profile page accessible"
   },
   {
     "objectID": "course-materials/week5-github-portfolios.html#continue-working",