Skip to content

/auk-notebooks

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

Updating README content - Issue 23 #34

Merged
merged 2 commits into from Mar 7, 2019
+25 −10

Conversation

Reviewers

@ruebot ruebot

@ianmilligan1 ianmilligan1

Assignees

@SamFritz SamFritz

Labels
enhancement
Projects
None yet
Milestone
No milestone
3 participants
@SamFritz @ruebot @ianmilligan1
@SamFritz
Copy link
Member

SamFritz commented Mar 7, 2019

This pull request addresses #23 and comes on the heels of additions/modifications made by @ruebot in issue #32

This pull requests does the following:

  • tweaked some of the text placements (move suggestion of using Anaconda or Docker under requirements section)
  • added in the URLs for dependencies - when I first ran through README (with Docker listed first), I ended up having to go to each dependency's URL to install - completely fresh computer. (@ruebot @ianmilligan1) please feel free to remove if you think this is unnecessary
  • included a short definition for what Docker and Anaconda are under each sub-heading
  • included a section that gives a brief overview of what outputs and visualizations are generated through the notebook
  • adjusted links in Docker Locally section, so the URL wasn't the whole sentence

Thanks for the second and third set of eyes!!
@SamFritz
tweaking some of the text and descriptions; adds in URLs for dependen… 
…cies, outlines types of visuals created with notebook
Loading status checks…
f8257c3

@SamFritz SamFritz added the enhancement label Mar 7, 2019

@SamFritz SamFritz self-assigned this Mar 7, 2019

@SamFritz SamFritz requested review from ruebot and ianmilligan1 Mar 7, 2019

@ruebot

ruebot requested changes Mar 7, 2019
View changes

Copy link
Member

ruebot left a comment

One small change, and a question.
README.md Outdated
@@ -38,6 +38,10 @@ python -m nltk.downloader punkt vader_lexicon stopwords
jupyter notebook
```

### Docker

Docker is a container-based virtual machine system that bundles dependencies together, this means you can build the docker image and it will work out of the box. To run the Jupyter Notebook via Docker, there are two options, Docker Hub and Docker Locally.

This comment has been minimized.

Sign in to view
Copy link
@ruebot

ruebot Mar 7, 2019

Member

Capitalize Docker: you can build the Docker image

This comment has been minimized.

Sign in to view
Copy link
@SamFritz

SamFritz Mar 7, 2019

Author Member

thanks for the catch!
README.md Outdated

There are several types of visualizations that you can produce in the Jupyter Notebook. A total of 14 outputs can be generated.

* *Domain Analysis* - provides information about what has been crawled (e.g. which domains) and how often.

This comment has been minimized.

Sign in to view
Copy link
@ruebot

ruebot Mar 7, 2019

Member

Should we capitalize the first word after the hyphen for each of these?

This comment has been minimized.

Sign in to view
Copy link
@ianmilligan1

ianmilligan1 Mar 7, 2019

Member

Yes that makes sense.
@ianmilligan1

ianmilligan1 requested changes Mar 7, 2019
View changes

Copy link
Member

ianmilligan1 left a comment

Some minor tweaks but this looks great!
README.md Outdated

There are several types of visualizations that you can produce in the Jupyter Notebook. A total of 14 outputs can be generated.

* *Domain Analysis* - provides information about what has been crawled (e.g. which domains) and how often.

This comment has been minimized.

Sign in to view
Copy link
@ianmilligan1

ianmilligan1 Mar 7, 2019

Member

Yes that makes sense.
README.md Outdated

There are several types of visualizations that you can produce in the Jupyter Notebook. A total of 14 outputs can be generated.

* *Domain Analysis* - provides information about what has been crawled (e.g. which domains) and how often.

This comment has been minimized.

Sign in to view
Copy link
@ianmilligan1

ianmilligan1 Mar 7, 2019

Member

Maybe change the - to a : in the list

i.e.

  • Domain Analysis: Provides information about what has been crawled (e.g. which domains) and how often.

and same for the other items in this bullet-pointed list.
README.md Outdated

This repository also uses the [Jupyter Docker Stacks](https://jupyter-docker-stacks.readthedocs.io/en/latest/index.html), which provide [a lot of helpful options to take advantage of](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/common.html#docker-options).
This repository also uses the [Jupyter Docker Stacks](https://jupyter-docker-stacks.readthedocs.io/en/latest/index.html), which provide some helpful options for [customizing](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/common.html#docker-options) the container environment.

This comment has been minimized.

Sign in to view
Copy link
@ianmilligan1

ianmilligan1 Mar 7, 2019

Member

some -> several
@ruebot

ruebot approved these changes Mar 7, 2019
View changes

@ianmilligan1

ianmilligan1 approved these changes Mar 7, 2019
View changes

@ianmilligan1 ianmilligan1 merged commit 5becb28 into master Mar 7, 2019
1 check passed

1 check passed

ci/dockercloud Your tests passed in Docker Cloud
Details

@ianmilligan1 ianmilligan1 deleted the issue-23 branch Mar 7, 2019

@SamFritz SamFritz referenced this pull request Mar 7, 2019

Closed

Update READ.ME #23

2 of 2 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.