Adds Notebook Learning Guide, Resolves #311 (#313)

* Adds links to derivative; tests; route config * Update img resolution, fixes prose, test style fix * Adding learning guide link to FAQ/docs Complements the blog post for now * MacOS -> macOS
archivesunleashed · Jul 11, 2019 · 1f1d9b0e5c305e0055186ffb6e64cd979759d15f · 1f1d9b0
1 parent 563e34f
commit 1f1d9b0e5c305e0055186ffb6e64cd979759d15f
diff --git a/app/assets/images/Notebook-01.png b/app/assets/images/Notebook-01.png
diff --git a/app/assets/images/Notebook-02.png b/app/assets/images/Notebook-02.png
diff --git a/app/assets/images/Notebook-03.png b/app/assets/images/Notebook-03.png
diff --git a/app/assets/images/Notebook-04.png b/app/assets/images/Notebook-04.png
diff --git a/app/assets/images/Notebook-05.png b/app/assets/images/Notebook-05.png
diff --git a/app/assets/images/Notebook-06.png b/app/assets/images/Notebook-06.png
diff --git a/app/assets/images/Notebook-07.png b/app/assets/images/Notebook-07.png
diff --git a/app/assets/images/Notebook-08.png b/app/assets/images/Notebook-08.png
diff --git a/app/assets/images/Notebook-09.png b/app/assets/images/Notebook-09.png
diff --git a/app/views/pages/derivatives.html.erb b/app/views/pages/derivatives.html.erb
@@ -33,17 +33,42 @@
     </div>
     <br />
     <h3 class="about_h3">Learning Guides</h3>
-      <p class="about_p">The following guides walk through how to use Cloud derivative files for further analysis.</p>
+      <p class="about_p">The following guides walk through how to use Cloud derivative files and the Archives Unleashed Cloud Notebooks for further analysis.</p>
     <div id="auk_deriv_accordionContainer accordion">
       <div class="auk_deriv_accord card">
         <div class="auk_deriv_accord-header card-header" id="headingOne">
           <h5 class="mb-0">
             <button class="btn btn-link" data-toggle="collapse" data-target="#collapseOne" aria-expanded="true" aria-controls="collapseOne">
-              Gephi & Raw Network Files
+              Archives Unleashed Cloud Notebooks
             </button>
           </h5>
         </div>
         <div id="collapseOne" class="collapse show" aria-labelledby="headingOne" data-parent="#accordion">
+          <div class="auk_deriv_accord_body card-body">
+            <p class="about_p">We are excited to introduce our Archives Unleashed Jupyter Notebooks, a prototype method for working with the derivatives generated by the Archives Unleashed Cloud. They allow you to interactively explore and filter the domain count information, extracted full text, and network visualization data generated by the Cloud.</p>
+            <table id="auk_deriv_accord_table">
+              <tbody class="auk_deriv_tbody_table">
+                  <td class="auk_deriv_td_table"><strong>Tutorial</strong></td>
+                  <td class="auk_deriv_td_table">
+                    <ul>
+                      <li class="card_li"><strong><%=link_to("Getting Started with the Archives Unleashed Cloud Jupyter Notebooks", "/derivatives/notebooks")%></strong>: This tutorial provides a basic walkthrough for integrating data from the Archives Unleashed Cloud with our Cloud Notebooks.</li>
+                    </ul>
+                  </td>
+                </tr>                
+            </table>
+          </div>
+        </div>
+      </div>
+    <div id="auk_deriv_accordionContainer accordion">
+      <div class="auk_deriv_accord card" id="accordion">
+        <div class="auk_deriv_accord-header card-header" id="headingTwo">
+          <h5 class="mb-0">
+            <button class="btn btn-link collapsed" data-toggle="collapse" data-target="#collapseTwo" aria-expanded="false" aria-controls="collapseTwo">
+              Gephi & Raw Network Files
+            </button>
+          </h5>
+        </div>
+        <div id="collapseTwo" class="collapse" aria-labelledby="headingOne" data-parent="#accordion">
           <div class="auk_deriv_accord_body card-body">
             <p class="about_p">When using the web as a historical source, the ability to see the way websites link to each other can be invaluable. However, using network analysis in historical research can also be a daunting prospect. </p>
             <table id="auk_deriv_accord_table">
@@ -77,12 +102,12 @@
       <div class="auk_deriv_accord card" id="accordion">
         <div class="auk_deriv_accord-header card-header" id="headingTwo">
           <h5 class="mb-0">
-            <button class="btn btn-link collapsed" data-toggle="collapse" data-target="#collapseTwo" aria-expanded="false" aria-controls="collapseTwo">
+            <button class="btn btn-link collapsed" data-toggle="collapse" data-target="#collapseThree" aria-expanded="false" aria-controls="collapseThree">
               Plain Text Files
             </button>
           </h5>
         </div>
-        <div id="collapseTwo" class="collapse" aria-labelledby="headingTwo" data-parent="#accordion">
+        <div id="collapseThree" class="collapse" aria-labelledby="headingTwo" data-parent="#accordion">
           <div class="auk_deriv_accord_body card-body">
             <p class="about_p">The full text of a web collection can be invaluable for a researcher! Archives Unleashed Cloud users will have access to the full text file. In it, each website within the web archive collection will have its full text presented on one line, along with information around when it was crawled, the name of the domain, and the full URL of the content.</p>
             <table id="auk_deriv_accord_table">
@@ -125,12 +150,12 @@
       <div class="auk_deriv_accord card">
         <div class="auk_deriv_accord-header card-header" id="headingThree">
           <h5 class="mb-0">
-            <button class="btn btn-link collapsed" data-toggle="collapse" data-target="#collapseThree" aria-expanded="false" aria-controls="collapseThree">
+            <button class="btn btn-link collapsed" data-toggle="collapse" data-target="#collapseFour" aria-expanded="false" aria-controls="collapseFour">
               Domains File
             </button>
           </h5>
         </div>
-        <div id="collapseThree" class="collapse" aria-labelledby="headingThree" data-parent="#accordion">
+        <div id="collapseFour" class="collapse" aria-labelledby="headingThree" data-parent="#accordion">
           <div class="auk_deriv_accord_body card-body">
             <p class="about_p">Sometimes you might just want to know what is inside a web archive! The web is a complex beast: a small web archive that aims to collect just one page might end up capturing embedded widgets and content from other websites just to make something play. Alternatively, a crawl might have been corrupted and begun to find material that's far out of scope.</p>
             <table id="auk_deriv_accord_table">

diff --git a/app/views/pages/documentation.html.erb b/app/views/pages/documentation.html.erb
@@ -102,8 +102,8 @@
 
     <a name="notebooks"></a><h3 class="about_h3">Exploring Derivatives with the Archives Unleashed Cloud Jupyter Notebooks</h3>
     <%= image_tag("AUK_Notebook.png", alt: "AUK Jupyter Notebook", class:"body_img")%>
-    <p class="about_p">We have prototype Jupyter Notebooks available for you to work with the derivative files that you download from the Cloud. You can read more about this in our blog post "<%= link_to('Exploring Web Archival Data through Archives Unleashed Cloud Jupyter Notebooks', 'https://news.archivesunleashed.org/exploring-web-archival-data-through-archives-unleashed-cloud-jupyter-notebooks-7605c6ca2b33', target: '_blank') %>". They allow you to interactively explore and filter the domain count information, extracted full text, and network visualization data generated by the Archives Unleashed Cloud.</p>
-    <p class="about_p">We are currently exploring greater integration between the notebooks and the Archives Unleashed Cloud. To use them now, please visit the GitHub repository <%= link_to('here', 'https://github.com/archivesunleashed/auk-notebooks', target: '_blank') %> and follow the instructions.</p>
+    <p class="about_p">We have prototype Jupyter Notebooks available for you to work with the derivative files that you download from the Cloud. You can read more about this in our blog post "<%= link_to('Exploring Web Archival Data through Archives Unleashed Cloud Jupyter Notebooks', 'https://news.archivesunleashed.org/exploring-web-archival-data-through-archives-unleashed-cloud-jupyter-notebooks-7605c6ca2b33', target: '_blank') %>" and in our learning guide "<%= link_to('Getting Started with the Archives Unleashed Cloud Jupyter Notebooks', '/derivatives/notebooks', target: '_blank') %>."</p>
+    <p class="about_p">The notebooks allow you to interactively explore and filter the domain count information, extracted full text, and network visualization data generated by the Archives Unleashed Cloud. We are currently exploring greater integration between the notebooks and the Archives Unleashed Cloud. To use them now, please visit the GitHub repository <%= link_to('here', 'https://github.com/archivesunleashed/auk-notebooks', target: '_blank') %> and follow the instructions.</p>
     <p class="about_p">This is still in the prototype stage. Any and all feedback and suggestions are greatly appreciated and can be sent to our project manager Samantha Fritz at <%= link_to('sam.fritz@archivesunleashed.org', 'mailto:sam.fritz@archivesunleashed.org', target: '_blank') %>.</p>
 
     <h3 class="about_h3">Need More Help?</h3>

diff --git a/app/views/pages/faq.html.erb b/app/views/pages/faq.html.erb
@@ -50,7 +50,7 @@
           <p class="about_p">The diagram is based on social network theory, which visualizes the communication or connection relationships between entities (individuals, groups, organizations, institutions).</p>
           <p class="about_p"><strong>I have the derivatives, but now what do I do?</strong></p>
           <p class="about_p">Now comes the fun part of digging into your web archival collections. The derivatives give you a starting point for further analysis. The way you approach analyzing the derivatives, however, will largely depend on the content of the collections, topic, and what some of your research questions are.</p>
-          <p class="about_p">To start your research process, we have prototype Jupyter Notebooks available for you to work with the derivatives generated by the Archives Unleashed Cloud. They allow you to interactively explore and filter the domain count information, extracted full text, and network visualization data generated by the Archives Unleashed Cloud. You can read more about this in our blog post "<%= link_to('Exploring Web Archival Data through Archives Unleashed Cloud Jupyter Notebooks', 'https://news.archivesunleashed.org/exploring-web-archival-data-through-archives-unleashed-cloud-jupyter-notebooks-7605c6ca2b33', target: '_blank') %>".</p>
+          <p class="about_p">To start your research process, we have prototype Jupyter Notebooks available for you to work with the derivatives generated by the Archives Unleashed Cloud. They allow you to interactively explore and filter the domain count information, extracted full text, and network visualization data generated by the Archives Unleashed Cloud. You can read more about this in our blog post "<%= link_to('Exploring Web Archival Data through Archives Unleashed Cloud Jupyter Notebooks', 'https://news.archivesunleashed.org/exploring-web-archival-data-through-archives-unleashed-cloud-jupyter-notebooks-7605c6ca2b33', target: '_blank') %>" and in our learning guide "<%= link_to('Getting Started with the Archives Unleashed Cloud Jupyter Notebooks', '/derivatives/notebooks', target: '_blank') %>."</p>
           <p class="about_p">We are currently exploring greater integration between the notebooks and the Archives Unleashed Cloud. To use them now, please visit the GitHub repository <%= link_to('here', 'https://github.com/archivesunleashed/auk-notebooks', target: '_blank') %> and follow the instructions.</p>
           <p class="about_p">Secondly, here are a few more ideas and resources to help you get started:</p>
           <ul><strong><%=link_to('Cloud Learning Guides','/derivatives') %></strong>: thanks in part to Sarah McTavish and Ian Milligan, there are a number of guides that walk through using each derivative file with additional tools. </ul>