FAQ skeleton and content; Resolves #210 #236

SamFritz · Dec 20, 2018

GitHub issue(s):

#210

What does this Pull Request do?

This PR will result in a static FAQ page as a reference for users . This page is formatted similarly to derivatives page with accordion style drop down menus.

As discussed, in instances where we are providing an email contact, we have linked to the newly created @archivesunleashed.org, and @SamFritz is first point of contact.

The work committed includes changes to:

faq.html.erb (where the faq content can be found)
override_bootstrap.scss (adds in separate css for accordion card found on faq page)
db/schema.rb (when i launched rails s I was asked to run command bin/rails db:migrate RAILS_ENV=development)

Additional Notes:

any email reference links to sam.fritz@archivesunleashed.org
where it makes sense I've outlined we can be contacted through email or slack, with appropriate links provided for both

Interested parties

@ianmilligan1 @ruebot thanks for you help with review of content.

codecov-io · Dec 20, 2018

Codecov Report

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

@@           Coverage Diff           @@
##           master     #236   +/-   ##
=======================================
  Coverage   92.49%   92.49%           
=======================================
  Files          35       35           
  Lines         533      533           
=======================================
  Hits          493      493           
  Misses         40       40

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 cd0a9c0...c3f3831. Read the comment docs.

ruebot · Dec 20, 2018

ruebot reviewed Dec 20, 2018

View changes

ruebot · Dec 20, 2018

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.

-ActiveRecord::Schema.define(version: 20181110005530) do
+ActiveRecord::Schema.define(version: 2018_11_10_005530) do


Why'd this change?

I'm not sure why this changed I didn't do this manually, but I have a feeling this changed when did the following:

ran rails s
ran bundle install
ran rails s again and got:

ActiveRecord::PendingMigrationError (Migrations are pending. To resolve this issue, run:bin/rails db:migrate RAILS_ENV=development):

Script looked like:

Then I was able to run rails s and able to preview through local

ruebot · Dec 20, 2018

ruebot requested changes Dec 20, 2018

View changes

Couple small fixes. Other than that, good to go!

ruebot · Dec 20, 2018

app/views/pages/faq.html.erb

+        <div id="collapseOne" class="collapse show" aria-labelledby="headingOne" data-parent="#accordion">
+          <div class="auk_faq_accord_body card-body">
+            <p class="about_p"><strong>How do I use the Archives Unleashed Cloud?</strong></p>
+            <p class="about_p">If you’re new to the Cloud, our <%=link_to('AUK documentation','/documentation') %> page gives a full walkthrough on how to set up and use your account and dashboard.</p>


Don't use these single quotes; use '.

I've changed this line to reflect your comment - didn't see the difference but chances are this was the first link_to situation.

Oh, it's in you're in this line, and a few other places.

ah gotchya!! Thanks for clarifying. Those curly quote always sneak in

ruebot · Dec 20, 2018

app/views/pages/faq.html.erb

+            <p class="about_p"><strong>How do I use the Archives Unleashed Cloud?</strong></p>
+            <p class="about_p">If you’re new to the Cloud, our <%=link_to('AUK documentation','/documentation') %> page gives a full walkthrough on how to set up and use your account and dashboard.</p>
+            <p class="about_p"><strong>I don’t have an Archive-It account! Can I still use the Archives Unleashed Cloud?</strong></p>
+            <p class="about_p">We currently only support Archive-It accounts, as our system is based on the Web Archiving Systems API, or WASAPI. In the future, we are hoping to expand the services that we support. If you have a web archiving service and would like to integrate with the Cloud, <%= link_to('drop us a line', 'mailto:sam.fritz@archivesunleashed.org', target: '_blank') %>.</p>


Let's link WASAPI to this https://github.com/WASAPI-Community/data-transfer-apis

Let's link to Archive-It here too https://archive-it.org/

ruebot · Dec 20, 2018

app/views/pages/faq.html.erb

+            <p class="about_p"><strong>I don’t have an Archive-It account! Can I still use the Archives Unleashed Cloud?</strong></p>
+            <p class="about_p">We currently only support Archive-It accounts, as our system is based on the Web Archiving Systems API, or WASAPI. In the future, we are hoping to expand the services that we support. If you have a web archiving service and would like to integrate with the Cloud, <%= link_to('drop us a line', 'mailto:sam.fritz@archivesunleashed.org', target: '_blank') %>.</p>
+            <p class="about_p"><strong>Can I can sync my Archive-It account with the Archives Unleashed Cloud without using Twitter or Github?</strong></p>
+            <p class="about_p">Right now authentication is only offered via Twitter and Github - we hope to expand this in the future. We’ve had some of our colleagues come to the Cloud without an account for either Twitter or GitHub, and if you’re in a similar situation we have recommended creating  a research based Twitter/Github account in order to use the Cloud. Don’t worry – you don’t need to code or tweet!</p>


s/Github/GitHub/

Let's link to twitter.com and github.com for the first instances of those as well.

ruebot · Dec 20, 2018

app/views/pages/faq.html.erb

+        <div id="collapseTwo" class="collapse" aria-labelledby="headingTwo" data-parent="#accordion">
+          <div class="auk_faq_accord_body card-body">
+            <p class="about_p"><strong>I’ve asked the system to process my collection, but the screen is still empty. How long does it take to analyze the collection?</strong></p>
+            <p class="about_p">Our Cloud works on a queue system, which means that as soon as you click “Analyze” collection, it has entered into a queue of all the jobs users are running. We operate on a first-in-first-out system, so somebody may have started processing their collection before you. Only when the analysis is done will you see all three derivatives.</p>


Let's change: Only when the analysis is done will you see all three derivatives
To: Only when the analysis is done will you see derivatives

We don't always return all 4.

ruebot · Dec 20, 2018

app/views/pages/faq.html.erb

+            <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>
+            <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>
+            <ul><strong>Cloud Hackathon team projects</strong>: at each <%= link_to('#hackarchives', 'https://archivesunleashed.org/events/', target: '_blank') %> event, teams have the opportunity to work with the Archives Unleashed Toolkit and other resources to uncover the hidden gems in their collections. Have a look at some of the final projects to see what types of visualizations and processes were used for analysis (<%= link_to('Toronto', 'https://archivesunleashed.org/toronto/', target: '_blank') %>,<%= link_to('Vancouver', 'https://archivesunleashed.org/vancouver/', target: '_blank') %>).</ul>
+            <ul><strong>External resources</strong>: there are so many other tools and resources available for users to do further analysis with their Cloud derivatives. Here are a few suggestions our team, as well as hackarchives participants, have used in the past.</ul>


Table is off for me.

Thanks for the catch! What browser are you using to view? I'll go into css to fix and hopefully I can see what you're experiencing.

ruebot · Dec 20, 2018

ruebot approved these changes Dec 20, 2018

View changes

ianmilligan1 · Dec 21, 2018

ianmilligan1 requested changes Dec 21, 2018

View changes

Looks great, @SamFritz, and renders very nicely on my local browser. The accordion styling worked expertly.

I just have a few minor tweaks here, almost exclusively just minor word additions or drops. Let me know if anything's unclear as you go through!

ianmilligan1 · Dec 21, 2018

app/views/pages/faq.html.erb

@@ -3,5 +3,140 @@
 <% cache do %>
 <div class="container">
  <h1 class=about_h1>FAQ</h1>
+  <p class="about_p">Have a questions about the Archives Unleashed Cloud? Check out some of our most frequently asked questions.</p>


Let's drop "a" so it's just "Have questions"

ianmilligan1 · Dec 21, 2018

app/views/pages/faq.html.erb

+        <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">
+              AUK Account and Dashboard


AUK -> "Archives Unleashed Cloud Account and Dashboard"

ianmilligan1 · Dec 21, 2018

app/views/pages/faq.html.erb

+        <div id="collapseOne" class="collapse show" aria-labelledby="headingOne" data-parent="#accordion">
+          <div class="auk_faq_accord_body card-body">
+            <p class="about_p"><strong>How do I use the Archives Unleashed Cloud?</strong></p>
+            <p class="about_p">If you're new to the Cloud, our <%=link_to('AUK documentation','/documentation') %> page gives a full walkthrough on how to set up and use your account and dashboard.</p>


"AUK documentation page" -> "documentation page"

ianmilligan1 · Dec 21, 2018

app/views/pages/faq.html.erb

+            <p class="about_p"><strong>I don't have an Archive-It account! Can I still use the Archives Unleashed Cloud?</strong></p>
+            <p class="about_p">We currently only support <%= link_to('Archive-It', 'https://archive-it.org/', target: '_blank') %> accounts, as our system is based on the Web Archiving Systems API, or <%= link_to('WASAPI', 'https://github.com/WASAPI-Community/data-transfer-apis', target: '_blank') %>. In the future, we are hoping to expand the services that we support. If you have a web archiving service and would like to integrate with the Cloud, <%= link_to('drop us a line', 'mailto:sam.fritz@archivesunleashed.org', target: '_blank') %>.</p>
+            <p class="about_p"><strong>Can I can sync my Archive-It account with the Archives Unleashed Cloud without using Twitter or Github?</strong></p>
+            <p class="about_p">Right now authentication is only offered via <%= link_to('Twitter', 'https://twitter.com/', target: '_blank') %> and <%= link_to('GitHub', 'https://github.com/', target: '_blank') %> - we hope to expand this in the future. We've had some of our colleagues come to the Cloud without an account for either Twitter or GitHub, and if you're in a similar situation we have recommended creating  a research based Twitter/Github account in order to use the Cloud. Don't worry – you don't need to code or tweet!</p>


"we have recommended creating a research based Twitter/Github account in order to use the Cloud."
->
"we recommend creating a research-based account in order to use the Cloud."

ianmilligan1 · Dec 21, 2018

app/views/pages/faq.html.erb

+            <p class="about_p">We currently only support <%= link_to('Archive-It', 'https://archive-it.org/', target: '_blank') %> accounts, as our system is based on the Web Archiving Systems API, or <%= link_to('WASAPI', 'https://github.com/WASAPI-Community/data-transfer-apis', target: '_blank') %>. In the future, we are hoping to expand the services that we support. If you have a web archiving service and would like to integrate with the Cloud, <%= link_to('drop us a line', 'mailto:sam.fritz@archivesunleashed.org', target: '_blank') %>.</p>
+            <p class="about_p"><strong>Can I can sync my Archive-It account with the Archives Unleashed Cloud without using Twitter or Github?</strong></p>
+            <p class="about_p">Right now authentication is only offered via <%= link_to('Twitter', 'https://twitter.com/', target: '_blank') %> and <%= link_to('GitHub', 'https://github.com/', target: '_blank') %> - we hope to expand this in the future. We've had some of our colleagues come to the Cloud without an account for either Twitter or GitHub, and if you're in a similar situation we have recommended creating  a research based Twitter/Github account in order to use the Cloud. Don't worry – you don't need to code or tweet!</p>
+            <p class="about_p"><strong>Why are some collections listed as public, and others are not?</strong></p>


"imported in from the"
->
"imported from the"

ianmilligan1 · Dec 21, 2018

app/views/pages/faq.html.erb

+        <div id="collapseTwo" class="collapse" aria-labelledby="headingTwo" data-parent="#accordion">
+          <div class="auk_faq_accord_body card-body">
+            <p class="about_p"><strong>I've asked the system to process my collection, but the screen is still empty. How long does it take to analyze the collection?</strong></p>
+            <p class="about_p">Our Cloud works on a queue system, which means that as soon as you click “Analyze” collection, it has entered into a queue of all the jobs users are running. We operate on a first-in-first-out system, so somebody may have started processing their collection before you. Only when the analysis is done will you see derivatives.</p>


"as soon as you click "Analyze" collection, it has entered into"
->
"as soon as you click "Analyze Collection," it has entered into"

ianmilligan1 · Dec 21, 2018

app/views/pages/faq.html.erb

+            <p class="about_p">Our Cloud works on a queue system, which means that as soon as you click “Analyze” collection, it has entered into a queue of all the jobs users are running. We operate on a first-in-first-out system, so somebody may have started processing their collection before you. Only when the analysis is done will you see derivatives.</p>
+            <p class="about_p">In terms of time, this estimate is based on a few factors, such as how many other users are in the queue and the size of your collection. You only need to click the “Analyze” button once. Don't worry: once your collection is done analyzing, we will send you an e-mail.</p>
+            <p class="about_p"><strong>Can I bring my own WARC files to the Cloud?</strong></p>
+            <p class="about_p">Right now the Archives Unleashed Cloud is only able to handle data by way of Archive-It subscriptions. As noted above, we are looking at ways of expanding this in the future.</p>


"We have a documentation and walk through instructions of how to use the Toolkit locally."
->
"We have documentation and walkthrough instructions on how to use the Toolkit locally."

ianmilligan1 · Dec 21, 2018

app/views/pages/faq.html.erb

+            <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>
+            <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>
+            <ul><strong>Cloud Hackathon team projects</strong>: at each <%= link_to('#hackarchives', 'https://archivesunleashed.org/events/', target: '_blank') %> event, teams have the opportunity to work with the Archives Unleashed Toolkit and other resources to uncover the hidden gems in their collections. Have a look at some of the final projects to see what types of visualizations and processes were used for analysis (<%= link_to('Toronto', 'https://archivesunleashed.org/toronto/', target: '_blank') %>,<%= link_to('Vancouver', 'https://archivesunleashed.org/vancouver/', target: '_blank') %>).</ul>


(Toronto,Vancouver)
->
(Toronto, Vancouver)

adds space after comma in list

ianmilligan1 · Dec 21, 2018

app/views/pages/faq.html.erb

@@ -3,5 +3,140 @@
 <% cache do %>
 <div class="container">
  <h1 class=about_h1>FAQ</h1>


I wonder if we should spell out FAQ as "Frequently Asked Questions" as the <h1> on this page (FAQ elsewhere like in menu bar makes sense).

SamFritz · Dec 21, 2018

Thanks for the review @ianmilligan1 and @ruebot. All suggestions have been committed.

ianmilligan1 · Dec 21, 2018

ianmilligan1 requested changes Dec 21, 2018

View changes

Super tiny minor change (can you tell I've been reading my own proofs for the last three weeks?) and then good to go on my end.

ianmilligan1 · Dec 21, 2018

app/views/pages/faq.html.erb

            <p class="about_p">In terms of time, this estimate is based on a few factors, such as how many other users are in the queue and the size of your collection. You only need to click the “Analyze” button once. Don't worry: once your collection is done analyzing, we will send you an e-mail.</p>
            <p class="about_p"><strong>Can I bring my own WARC files to the Cloud?</strong></p>
            <p class="about_p">Right now the Archives Unleashed Cloud is only able to handle data by way of Archive-It subscriptions. As noted above, we are looking at ways of expanding this in the future.</p>
-            <p class="about_p">You are always welcome to use the <%= link_to('Archives Unleashed Toolkit', 'https://archivesunleashed.org/aut/', target: '_blank') %> to analyze your own WARC files, though this will require a bit of knowledge and patience with the command line. We have a <%= link_to('documentation', 'https://archivesunleashed.org/aut/', target: '_blank') %> and walk through instructions of how to use the Toolkit locally.</p>
+            <p class="about_p">You are always welcome to use the <%= link_to('Archives Unleashed Toolkit', 'https://archivesunleashed.org/aut/', target: '_blank') %> to analyze your own WARC files, though this will require a bit of knowledge and patience with the command line. We have <%= link_to('documentation', 'https://archivesunleashed.org/aut/', target: '_blank') %> and walkthrough on how to use the Toolkit locally.</p>


"and walkthrough on how to"
->
"and a walkthrough on how to" or "and walkthroughs on how to"

ianmilligan1 · Dec 21, 2018

ianmilligan1 approved these changes Dec 21, 2018

View changes

committing faq skeleton and content

Loading status checks…

b4e511e

SamFritz added question discussion labels Dec 20, 2018

SamFritz self-assigned this Dec 20, 2018

SamFritz requested review from ruebot and ianmilligan1 Dec 20, 2018

changes to syntax and css

Loading status checks…

385f222

minor syntax and content changes based on review feedback

Loading status checks…

4f87f4b

small phrase change to comply with review

Loading status checks…

c3f3831

ruebot deleted the issue-210 branch Dec 21, 2018

ruebot added a commit that referenced this pull request Dec 21, 2018

Follow on to #236.

Verified

This commit was signed with a verified signature.

ruebot Nick Ruest

GPG key ID: 417FAF1A0E1080CD Learn about signing commits

Loading status checks…

facd00a

ruebot added a commit that referenced this pull request Dec 21, 2018

Follow on to #236.

Verified

This commit was signed with a verified signature.

ruebot Nick Ruest

GPG key ID: 417FAF1A0E1080CD Learn about signing commits

Loading status checks…

65bc1da

archivesunleashed/auk

Join GitHub today

FAQ skeleton and content; Resolves #210 #236

Conversation

SamFritz commented Dec 20, 2018

What does this Pull Request do?

Additional Notes:

Interested parties

SamFritz added question discussion labels Dec 20, 2018

SamFritz self-assigned this Dec 20, 2018

SamFritz requested review from ruebot and ianmilligan1 Dec 20, 2018

This comment has been minimized.

codecov-io commented Dec 20, 2018 • edited

Codecov Report

ruebot reviewed Dec 20, 2018 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ruebot requested changes Dec 20, 2018 View changes

ruebot left a comment

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.

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.

This comment has been minimized.

ruebot approved these changes Dec 20, 2018 View changes

ianmilligan1 requested changes Dec 21, 2018 View changes

ianmilligan1 left a comment

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.

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.

SamFritz commented Dec 21, 2018

ianmilligan1 requested changes Dec 21, 2018 View changes

ianmilligan1 left a comment

This comment has been minimized.

ianmilligan1 approved these changes Dec 21, 2018 View changes

Hide details View details ruebot merged commit 5225960 into master Dec 21, 2018 3 checks passed

3 checks passed

ruebot deleted the issue-210 branch Dec 21, 2018

ruebot added a commit that referenced this pull request Dec 21, 2018

ruebot added a commit that referenced this pull request Dec 21, 2018

codecov-io commented Dec 20, 2018 •

edited

ruebot reviewed Dec 20, 2018

View changes

ruebot requested changes Dec 20, 2018

View changes

ruebot approved these changes Dec 20, 2018

View changes

ianmilligan1 requested changes Dec 21, 2018

View changes

ianmilligan1 requested changes Dec 21, 2018

View changes

ianmilligan1 approved these changes Dec 21, 2018

View changes

ruebot merged commit `5225960` into master Dec 21, 2018
3 checks passed