Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding "Getting Started" page to the website, resolves #120 #121

Merged
merged 4 commits into from May 8, 2019

Conversation

@ianmilligan1
Copy link
Member

commented May 3, 2019

As noted in #120, our website is a bit tough to get into. So here's a "getting started" page that basically provides a basic introduction to what our project is about. Right now, in this version, it adds:

  • Overview (which is the table as suggested by @SamFritz: tool, skill, what it does, what you need, ideal for)
  • And then for each of the tools, a very short introduction and then some screenshots. To make things easier, they are just screenshots cribbed from elsewhere in the site. That way, we don't have to update them all, just the ones on the specific page when interfaces, etc. change.

We probably want to workshop specific language, so we can do so on this draft PR.

Example Screenshots of the Page
Screen Shot 2019-05-03 at 3 40 43 PM

Screen Shot 2019-05-03 at 3 40 52 PM

Initial kick at #120; adds "getting started" page
- An overview; selected screenshots for each tool.

@ianmilligan1 ianmilligan1 requested review from ruebot and SamFritz May 3, 2019

@ruebot
ruebot approved these changes May 3, 2019
Copy link
Member

left a comment

Overall good to go.

Just some language tweaks, and good on my end.


| Tool | Skill | What it Does | What You Need | Ideal For |
|:--------------------------:|--------------|--------------|---------------|-----------|
| ![logo](/images/cloud-logo.png) | Beginner | The **[Archives Unleashed Cloud](/cloud)** is a web-based GUI front end for working with [**Archive-It**](https://archive-it.org) collections. Drawing on your Archive-It credentials, you can sync your collections, run basic analyses, and generate a standardized set of research derivatives: full text, network diagrams, and basic statistics on your collection. | This does not require technical skills. However, you need an **Archive-It** account. You can get this if you are an Archive-It subscriber, **or** if you connect with a librarian responsible for a collection they can generate you a guest account. | Librarians, and researchers who know a librarian with an Archive-It account! |

This comment has been minimized.

Copy link
@ruebot

ruebot May 3, 2019

Member

web based platform

This comment has been minimized.

Copy link
@ruebot

ruebot May 3, 2019

Member

"standardized set of research derivatives: full text, network diagrams, and basic statistics on your collection" -- link that to derivatives documentation?

| Tool | Skill | What it Does | What You Need | Ideal For |
|:--------------------------:|--------------|--------------|---------------|-----------|
| ![logo](/images/cloud-logo.png) | Beginner | The **[Archives Unleashed Cloud](/cloud)** is a web-based GUI front end for working with [**Archive-It**](https://archive-it.org) collections. Drawing on your Archive-It credentials, you can sync your collections, run basic analyses, and generate a standardized set of research derivatives: full text, network diagrams, and basic statistics on your collection. | This does not require technical skills. However, you need an **Archive-It** account. You can get this if you are an Archive-It subscriber, **or** if you connect with a librarian responsible for a collection they can generate you a guest account. | Librarians, and researchers who know a librarian with an Archive-It account! |
| ![logo](/images/notebook-logo.png) | Beginner/Intermediate | The **[Archives Unleashed Notebooks](/notebooks)** are web-based Jupyter Notebooks that can help you work with the output of the Archives Unleashed Cloud. While they are a bit difficult to install, once you have them up and running you can use your web browser to work through interactive tutorials! Explore your data through rich visualizations! | You need to install the "dependencies" for the notebooks. While you can follow instructions, it does require running commands in your "command line." This requires an intermediate level of technical knowledge. We [recommend this tutorial](https://programminghistorian.org/en/lessons/intro-to-bash). | Researchers who want to explore their web archival collections. |

This comment has been minimized.

Copy link
@ruebot

ruebot May 3, 2019

Member

strike web based (it's redundant)

This comment has been minimized.

Copy link
@ruebot

ruebot May 3, 2019

Member

"While they are a bit difficult to install" I'd strike that.

@ianmilligan1

This comment has been minimized.

Copy link
Member Author

commented May 6, 2019

I guess with such positive feedback I will move out of review. We can always add the video later?

@ianmilligan1 ianmilligan1 marked this pull request as ready for review May 6, 2019

@ruebot
ruebot approved these changes May 7, 2019
|:--------------------------:|--------------|--------------|---------------|-----------|
| ![logo](/images/cloud-logo.png) | Beginner | The **[Archives Unleashed Cloud](/cloud)** is a web-based platform for working with [**Archive-It**](https://archive-it.org) collections. Drawing on your Archive-It credentials, you can sync your collections, run basic analyses, and generate a [standardized set of research derivatives: full text, network diagrams, and basic statistics on your collection](https://cloud.archivesunleashed.org/derivatives). | This does not require technical skills. However, you need an **Archive-It** account. You can get this if you are an Archive-It subscriber, **or** if you connect with a librarian responsible for a collection they can generate you a guest account. | Librarians, and researchers who know a librarian with an Archive-It account! |
| ![logo](/images/notebook-logo.png) | Beginner/Intermediate | The **[Archives Unleashed Notebooks](/notebooks)** are Jupyter Notebooks that can help you work with the output of the Archives Unleashed Cloud. Once you have them up and running you can use your web browser to work through interactive tutorials! Explore your data through rich visualizations! | You need to install the "dependencies" for the notebooks. While you can follow instructions, it does require running commands in your "command line." This requires an intermediate level of technical knowledge. We [recommend this tutorial](https://programminghistorian.org/en/lessons/intro-to-bash). | Researchers who want to explore their web archival collections. |
| ![logo](/images/warclight-logo.png) | Advanced | **[Warclight](/warclight)** is a search engine that lets users discover web archives. Think of it like the library catalogue meeting the WARC file! While it is easy to use, setting it up on your own collections requires an advanced level of knowledge. | You need a lot of WARCs that would benefit from this search engine. If you don't know what WARCs are, this is not the tool for you! | Librarians and archivists who have been collecting web archives and who want to enhance their discoverability. |

This comment has been minimized.

Copy link
@SamFritz

SamFritz May 8, 2019

Member

love this description :)

This comment has been minimized.

Copy link
@SamFritz

SamFritz May 8, 2019

Member

Just wondering if it would be useful to help ball park "a lot of WARCs"?

This comment has been minimized.

Copy link
@SamFritz

SamFritz May 8, 2019

Member

Suggestion:
Librarians and archivists who have been collecting web archives and who want to enhance their discoverability. -->
Librarians and archivists who have been collecting web archives and want to enhance collection discoverability. -->

This comment has been minimized.

Copy link
@ianmilligan1

ianmilligan1 May 8, 2019

Author Member

Great, thanks @SamFritz! After reading this I think "a lot of WARCs" is misleading.. it really is just having WARCs, whether it's one or many.

| ![logo](/images/cloud-logo.png) | Beginner | The **[Archives Unleashed Cloud](/cloud)** is a web-based platform for working with [**Archive-It**](https://archive-it.org) collections. Drawing on your Archive-It credentials, you can sync your collections, run basic analyses, and generate a [standardized set of research derivatives: full text, network diagrams, and basic statistics on your collection](https://cloud.archivesunleashed.org/derivatives). | This does not require technical skills. However, you need an **Archive-It** account. You can get this if you are an Archive-It subscriber, **or** if you connect with a librarian responsible for a collection they can generate you a guest account. | Librarians, and researchers who know a librarian with an Archive-It account! |
| ![logo](/images/notebook-logo.png) | Beginner/Intermediate | The **[Archives Unleashed Notebooks](/notebooks)** are Jupyter Notebooks that can help you work with the output of the Archives Unleashed Cloud. Once you have them up and running you can use your web browser to work through interactive tutorials! Explore your data through rich visualizations! | You need to install the "dependencies" for the notebooks. While you can follow instructions, it does require running commands in your "command line." This requires an intermediate level of technical knowledge. We [recommend this tutorial](https://programminghistorian.org/en/lessons/intro-to-bash). | Researchers who want to explore their web archival collections. |
| ![logo](/images/warclight-logo.png) | Advanced | **[Warclight](/warclight)** is a search engine that lets users discover web archives. Think of it like the library catalogue meeting the WARC file! While it is easy to use, setting it up on your own collections requires an advanced level of knowledge. | You need a lot of WARCs that would benefit from this search engine. If you don't know what WARCs are, this is not the tool for you! | Librarians and archivists who have been collecting web archives and who want to enhance their discoverability. |
| ![logo](/images/toolkit-logo.png) | Advanced | The **[Archives Unleashed Toolkit](/toolkit)** is an Apache Spark-based platform for analyzing web archives at scale. When you use the Archives Unleashed Cloud, you are using the Toolkit in the back end! As you can see from the documentation page, the Toolkit is very powerful. However, it is an advanced tool that requires a high-level of technical knowledge to use --- or at least, patience and effort. We do have a **hands-on walkthrough** [here](/aut/lesson) | You would need a lot of WARCs that would benefit from computationally exploring them at scale. | Researchers who want to explore their WARCs at scale, and who need more flexibility than the Cloud provides. |

This comment has been minimized.

Copy link
@SamFritz

SamFritz May 8, 2019

Member

need a . after hands-on walkthrough [here]

This comment has been minimized.

Copy link
@SamFritz

SamFritz May 8, 2019

Member

suggestion:
Researchers who want to explore their WARCs at scale, and who need more flexibility than the Cloud provides. -->
Researchers who want to explore their WARCs at scale and need more flexibility than the Cloud provides.

| Tool | Skill | What it Does | What You Need | Ideal For |
|:--------------------------:|--------------|--------------|---------------|-----------|
| ![logo](/images/cloud-logo.png) | Beginner | The **[Archives Unleashed Cloud](/cloud)** is a web-based platform for working with [**Archive-It**](https://archive-it.org) collections. Drawing on your Archive-It credentials, you can sync your collections, run basic analyses, and generate a [standardized set of research derivatives: full text, network diagrams, and basic statistics on your collection](https://cloud.archivesunleashed.org/derivatives). | This does not require technical skills. However, you need an **Archive-It** account. You can get this if you are an Archive-It subscriber, **or** if you connect with a librarian responsible for a collection they can generate you a guest account. | Librarians, and researchers who know a librarian with an Archive-It account! |
| ![logo](/images/notebook-logo.png) | Beginner/Intermediate | The **[Archives Unleashed Notebooks](/notebooks)** are Jupyter Notebooks that can help you work with the output of the Archives Unleashed Cloud. Once you have them up and running you can use your web browser to work through interactive tutorials! Explore your data through rich visualizations! | You need to install the "dependencies" for the notebooks. While you can follow instructions, it does require running commands in your "command line." This requires an intermediate level of technical knowledge. We [recommend this tutorial](https://programminghistorian.org/en/lessons/intro-to-bash). | Researchers who want to explore their web archival collections. |

This comment has been minimized.

Copy link
@SamFritz

SamFritz May 8, 2019

Member

suggestion:
"This requires an intermediate....." --> An intermediate level of technical knowledge is recommended. We suggest this tutorial

| ![logo](/images/warclight-logo.png) | Advanced | **[Warclight](/warclight)** is a search engine that lets users discover web archives. Think of it like the library catalogue meeting the WARC file! While it is easy to use, setting it up on your own collections requires an advanced level of knowledge. | You need a lot of WARCs that would benefit from this search engine. If you don't know what WARCs are, this is not the tool for you! | Librarians and archivists who have been collecting web archives and who want to enhance their discoverability. |
| ![logo](/images/toolkit-logo.png) | Advanced | The **[Archives Unleashed Toolkit](/toolkit)** is an Apache Spark-based platform for analyzing web archives at scale. When you use the Archives Unleashed Cloud, you are using the Toolkit in the back end! As you can see from the documentation page, the Toolkit is very powerful. However, it is an advanced tool that requires a high-level of technical knowledge to use --- or at least, patience and effort. We do have a **hands-on walkthrough** [here](/aut/lesson) | You would need a lot of WARCs that would benefit from computationally exploring them at scale. | Researchers who want to explore their WARCs at scale, and who need more flexibility than the Cloud provides. |

## Tools in Action: The Cloud

This comment has been minimized.

Copy link
@SamFritz

SamFritz May 8, 2019

Member

great titles!

@SamFritz
Copy link
Member

left a comment

Getting started page looks great @ianmilligan1. Just added in a few suggestions for wording, please feel free to use any that you think are beneficial :)

@SamFritz SamFritz merged commit 0a5c5c5 into master May 8, 2019

@ianmilligan1 ianmilligan1 deleted the issue-120 branch May 8, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.