Highlight Notebooks in Documentation and Collection View #286

ianmilligan1 · Apr 17, 2019

GitHub issue(s):

If you are responding to an issue, please mention their numbers below.

#285

What does this Pull Request do?

This pull request adds in discussion of the notebooks as a "prototype" service in the documentation and FAQ, as well as in the collection view. The first two are straightforward, I am less sure about the latter.

Here is what the collection view looks like in this PR:

Note that I've added an additional link to the documentation section under the notebook.

How should this be tested?

TravisCI should turn green, but more importantly, reviewers should look at the additional prose and make sure it is clear as well as the look and feel of the link. I am looking for any suggestions around the best way to highlight this without cluttering the page..

Interested parties

@ruebot @greebie @SamFritz

codecov-io · Apr 17, 2019

Codecov Report

Merging #286 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #286   +/-   ##
=======================================
  Coverage   96.22%   96.22%           
=======================================
  Files          35       35           
  Lines         557      557           
=======================================
  Hits          536      536           
  Misses         21       21

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ade3aa8...7f5d493. Read the comment docs.

ruebot · Apr 17, 2019

ruebot reviewed Apr 17, 2019

View changes

ruebot · Apr 17, 2019

app/views/collections/show.html.erb

@@ -97,7 +97,7 @@
          <% unless !File.exists? textfilter_path(@user.id, @collection.id, @collection.account) %>
            <%= link_to('Text by Domains<br />'.html_safe + number_to_human_size(File.size(textfilter_path(@user.id, @collection.id, @collection.account))), user_collection_download_textfilter_path(@user.id, @collection.id, @collection.account), class: 'btn btn-primary', 'data-toggle': 'tooltip', 'data-placement': 'top', title: 'A zip file that contains the text of the top ten domains within a web archive, each within their own text file. Within the files you can find the crawl date, full URL, and the plain text of each page within the file.') %>
          <% end %>
-          <p><small><%=link_to("You can find information about how to use these files here.", "/derivatives")%></small></p>
+          <p><small><%=link_to("Learn more about these files here.", "/derivatives")%> <%=link_to("We also have a prototype Jupyter Notebook service available.", "/documentation#notebooks")%></small></p>


Not sure about calling it a service. But then again, I'm sitting here and can't think of a better alternative. 🤷‍♂️

Agreed, I also struggled with this - it's not quite a service, but we also probably need something beyond just a "jupyter notebook."

Other options could include?

"We also have prototype Archives Unleashed Cloud Jupiter Notebooks available."

"We also have a prototype Jupyter Notebook application available." (?)

"We also have a prototype Jupyter Notebook download available."

Let's do that first one.

Tough call, but I agree - I think if we go with the first option it leaves the language flexible enough and we can revisit down the line.

OK (and with "Jupyter" - damn Safari autocorrect).

ruebot · Apr 17, 2019

ruebot reviewed Apr 17, 2019

View changes

ruebot · Apr 17, 2019

app/views/pages/documentation.html.erb

@@ -98,6 +98,12 @@
    <%= image_tag("AUK_neighbours.png", alt: "AUK Interactive Hyperlink Diagram Explained", class:"body_img")%>
    <%= image_tag("AUK_hover.png", alt: "AUK Interactive Hyperlink Diagram hover feature", class:"body_img")%>

+    <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 a prototype Jupyter Notebook available for you to work with the derivatives 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') %>". 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>


Should we have: "We have a..." or "We have some..." since we'll probably merge archivesunleashed/auk-notebooks#51 today.

ruebot · Apr 17, 2019

ruebot reviewed Apr 17, 2019

View changes

ruebot · Apr 17, 2019

app/views/pages/faq.html.erb

@@ -49,7 +49,10 @@
          <p class="about_p">The interactive hyperlink diagram was designed to help users see their web archive collections at a glance, and visualizes the connections between the domains present within the collection.</p>
          <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 on your research questions. The way you approach analyzing the derivatives will largely depend on the content of the collections, topic, and what some of your research questions are, but here are a few ideas and resources to help get you started:</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 on your research questions. The way you approach analyzing the derivatives will largely depend on the content of the collections, topic, and what some of your research questions are.</p>
+          <p class="about_p">First, we have a prototype Jupyter Notebook available for you to work with the derivatives 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') %>". 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>


Same as above.

ruebot · Apr 17, 2019

ruebot approved these changes Apr 17, 2019

View changes

SamFritz · Apr 17, 2019

SamFritz approved these changes Apr 17, 2019

View changes

Looks good, just a few suggestions

SamFritz · Apr 17, 2019

app/views/collections/show.html.erb

@@ -97,7 +97,7 @@
          <% unless !File.exists? textfilter_path(@user.id, @collection.id, @collection.account) %>
            <%= link_to('Text by Domains<br />'.html_safe + number_to_human_size(File.size(textfilter_path(@user.id, @collection.id, @collection.account))), user_collection_download_textfilter_path(@user.id, @collection.id, @collection.account), class: 'btn btn-primary', 'data-toggle': 'tooltip', 'data-placement': 'top', title: 'A zip file that contains the text of the top ten domains within a web archive, each within their own text file. Within the files you can find the crawl date, full URL, and the plain text of each page within the file.') %>
          <% end %>
-          <p><small><%=link_to("You can find information about how to use these files here.", "/derivatives")%></small></p>
+          <p><small><%=link_to("Learn more about these files here.", "/derivatives")%> <%=link_to("We also have a prototype Jupyter Notebook service available.", "/documentation#notebooks")%></small></p>


Tough call, but I agree - I think if we go with the first option it leaves the language flexible enough and we can revisit down the line.

SamFritz · Apr 17, 2019

app/views/pages/documentation.html.erb

+    <%= 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 derivatives 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') %>". 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">Note that this is a prototype service. Any and all feedback and suggestions are greatly appreciated.</p>


drop 'service'

(maybe: 'Note that this is still in the prototype stage.')?

Perhaps we should add in contact info for feedback?

'Any and all feedback and suggestions are greatly appreciated and can be sent to our project manager at sam.fritz@archivesunleashed.org'

Great idea, let me add this!

ianmilligan1 · Apr 17, 2019

OK (sorry for all the commits – downside of working in a meeting). I think it is ready for re-review now. Appreciate all the feedback everybody.

ruebot · Apr 17, 2019

ruebot approved these changes Apr 17, 2019

View changes

greebie · Apr 17, 2019

greebie approved these changes Apr 17, 2019

View changes

ianmilligan1 added some commits Apr 17, 2019

Highlights Jupyter Notebook; resolves #285

8aebadd

Adding internal anchor link for documentation

Loading status checks…

08908d7

ianmilligan1 requested review from greebie, ruebot and SamFritz Apr 17, 2019

Notes plural Jupyter notebooks, re @ruebot review

Loading status checks…

0a9814b

ianmilligan1 added some commits Apr 17, 2019

Changing Notebook link text on collection view.

Loading status checks…

4614ddd

Adding @SamFritz contact information to docs

Loading status checks…

249f5e3

@SamFritz review

Loading status checks…

7f5d493

ruebot deleted the Issue-285 branch Apr 17, 2019

archivesunleashed/auk

Highlight Notebooks in Documentation and Collection View #286

Highlight Notebooks in Documentation and Collection View #286

ianmilligan1 commented Apr 17, 2019

ianmilligan1 added some commits Apr 17, 2019

ianmilligan1 requested review from greebie, ruebot and SamFritz Apr 17, 2019

This comment has been minimized.

codecov-io commented Apr 17, 2019 •

edited

ruebot reviewed Apr 17, 2019

View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ruebot reviewed Apr 17, 2019

View changes

This comment has been minimized.

ruebot reviewed Apr 17, 2019

View changes

This comment has been minimized.

ruebot approved these changes Apr 17, 2019

View changes

SamFritz approved these changes Apr 17, 2019

View changes

SamFritz left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ianmilligan1 added some commits Apr 17, 2019

This comment has been minimized.

ianmilligan1 commented Apr 17, 2019

ruebot approved these changes Apr 17, 2019

View changes

greebie approved these changes Apr 17, 2019

View changes

ruebot merged commit `a9a11aa` into master Apr 17, 2019
3 checks passed

3 checks passed

ruebot deleted the Issue-285 branch Apr 17, 2019

archivesunleashed/auk

Join GitHub today

Highlight Notebooks in Documentation and Collection View #286

Conversation

ianmilligan1 commented Apr 17, 2019

What does this Pull Request do?

How should this be tested?

Interested parties

ianmilligan1 added some commits Apr 17, 2019

ianmilligan1 requested review from greebie, ruebot and SamFritz Apr 17, 2019

This comment has been minimized.

codecov-io commented Apr 17, 2019 • edited

Codecov Report

ruebot reviewed Apr 17, 2019 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ruebot reviewed Apr 17, 2019 View changes

This comment has been minimized.

ruebot reviewed Apr 17, 2019 View changes

This comment has been minimized.

ruebot approved these changes Apr 17, 2019 View changes

SamFritz approved these changes Apr 17, 2019 View changes

SamFritz left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ianmilligan1 added some commits Apr 17, 2019

This comment has been minimized.

ianmilligan1 commented Apr 17, 2019

ruebot approved these changes Apr 17, 2019 View changes

greebie approved these changes Apr 17, 2019 View changes

Hide details View details ruebot merged commit a9a11aa into master Apr 17, 2019 3 checks passed

3 checks passed

ruebot deleted the Issue-285 branch Apr 17, 2019

codecov-io commented Apr 17, 2019 •

edited

ruebot reviewed Apr 17, 2019

View changes

ruebot reviewed Apr 17, 2019

View changes

ruebot reviewed Apr 17, 2019

View changes

ruebot approved these changes Apr 17, 2019

View changes

SamFritz approved these changes Apr 17, 2019

View changes

ruebot approved these changes Apr 17, 2019

View changes

greebie approved these changes Apr 17, 2019

View changes

ruebot merged commit `a9a11aa` into master Apr 17, 2019
3 checks passed